Skip to content

Commit

Permalink
[REJECTED] Add check_format tooling
Browse files Browse the repository at this point in the history
Update tools/Makefile.unix
/README.txt:Added check_format
  • Loading branch information
davids5 authored and dagar committed Dec 24, 2019
1 parent 30e1808 commit a14d2ce
Show file tree
Hide file tree
Showing 3 changed files with 101 additions and 1 deletion.
9 changes: 9 additions & 0 deletions README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1373,6 +1373,15 @@ Build Targets and Options
Removes derived object files, archives, executables, and temporary
files, but retains the configuration and context files and directories.

check_format

Will run nxstyle to check compliance with the NuttX coding standard on
the files the have been changed relative to master. This feature is only
available if 1) git is installed and 2) the changed files are located in
the local git repository and have been committed. The benefit of this
flow is that commits that only effect formatting changes do not over
shadow code changes. As of this writting this is a Unix only feature.

distclean

Does 'clean' then also removes all configuration and context files.
Expand Down
21 changes: 20 additions & 1 deletion tools/Makefile.unix
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ BIN = $(NUTTXNAME)$(EXEEXT)
all: $(BIN)
.PHONY: dirlinks context clean_context check_context config oldconfig menuconfig nconfig qconfig gconfig export subdir_clean clean subdir_distclean distclean apps_clean apps_distclean version_info
ifeq ($(GIT_DIR),y)
.PHONY: $(TOPDIR)/.version
.PHONY: $(TOPDIR)/.version check_format
endif

# Target used to copy include/nuttx/lib/math.h. If CONFIG_ARCH_MATH_H is
Expand Down Expand Up @@ -319,6 +319,15 @@ tools/cnvwindeps$(HOSTEXEEXT):
# $(Q) echo "No .config file found, creating one"
# $(Q) tools/initialconfig$(HOSTEXEEXT)

# make it easy to see what is happening

COLOR_BLUE = \033[0;94m
NO_COLOR = \033[m

define colorecho
+@echo -e '${COLOR_BLUE}${1} ${NO_COLOR}'
endef

# Link the arch/<arch-name>/include directory to include/arch

include/arch: .config
Expand Down Expand Up @@ -695,3 +704,13 @@ apps_distclean:
ifneq ($(APPDIR),)
$(Q) $(MAKE) -C "$(TOPDIR)/$(APPDIR)" TOPDIR="$(TOPDIR)" distclean
endif

ifeq ($(GIT_DIR),y)
tools/nxstyle$(EXEEXT): tools/nxstyle.c
$(Q) $(MAKE) -C tools -f Makefile.host nxstyle$(EXEEXT)

check_format: tools/nxstyle$(EXEEXT)
$(call colorecho,'Checking NuttX formatting with nxstyle')
@$(TOPDIR)/tools/check_code_style.sh
@cd "$(SRC_DIR)" && git diff --check
endif
72 changes: 72 additions & 0 deletions tools/check_code_style.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
#!/usr/bin/env bash
#
# Copyright (c) 2012 - 2019, PX4 Development Team
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice, this
# list of conditions and the following disclaimer.
#
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# * Neither the name of the copyright holder nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
# An example hook script to verify what is about to be committed.
# Called by "git commit" with no arguments. The hook should
# # exit with non-zero status after issuing an appropriate message if
# it wants to stop the commit.
#
BRACH_POINT=px4_firmware_nuttx-8.2
if [ ! "$(git rev-parse --is-inside-work-tree 2>/dev/null)" ]; then
echo "$0 can only be run with git installed and inside of a git repository"
exit 1
fi

if [ -z "$1" ]; then
FILES=$(git diff $BRACH_POINT --name-only);
else
FILES=$1
fi

DIR=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )
for FILE in $FILES; do
FILENAME=$(basename $FILE)
FILE_EXT="${FILENAME#*.}"
if [ -f "$FILE" ]; then
if [ "$FILE_EXT" = "c" ] || [ "$FILE_EXT" = "h" ]; then
CHECK_FAILED=$(${DIR}/nxstyle -m 80 $FILE)
# if [ -n "$CHECK_FAILED" ]; then
# ${DIR}/fix_code_style.sh --quiet < $FILE > $FILE.pretty
#
# echo
# git --no-pager diff --no-index --minimal --histogram --color=always $FILE $FILE.pretty
# rm -f $FILE.pretty
# echo
#
# if [[ $NXSTYLE_FIX -eq 1 ]]; then
# ${DIR}/fix_code_style.sh $FILE
# else
# echo $FILE 'bad formatting, please run "make format" or "./Tools/some tool when we get one/fix_code_style.sh' $FILE'"'
# exit 1
# fi
# fi
fi
fi
done

0 comments on commit a14d2ce

Please sign in to comment.