Skip to content

Master pr nxstyle improvments #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
davids5 wants to merge 2 commits into from
Closed

Master pr nxstyle improvments #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
711cb9c
nxstyle - output compiler like error format
davids5 Dec 22, 2019
e53a94f
Add check_format
davids5 Dec 22, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1368,6 +1368,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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,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
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 @@ -324,6 +324,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
Copy link
Contributor

@patacongo patacongo Dec 23, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no coding standard governing Makefiles. Other locations in this file do put spaces after comments, just like the C requirement.

Copy link
Contributor Author

@davids5 davids5 Dec 23, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. Yes there seems to be the "what you do" and what we have documented - disconnect.

Please use the "Suggested Change Button or ctr-g"

Copy link
Contributor

@xiaoxiang781216 xiaoxiang781216 Dec 23, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@davids5 I would prefer we work on check_code_style.sh first, and forget Makefile.unix at all.
Why? this avoid we couple the script logic with Makefle, for example:
1.The above implementation make the standalone script can't colorize the output.
2.The dependence rule can't work if user invoke the script from shell directly.
The best aproach is that we focus on the script development and make it work from command line as we want, then we can integrate the script either as the make target or precommit hook. Otherwise, the script will do a major rework for the standalone case.
Invoking the script from command line is the key feature for this tool, becasue we need integrate this tool into various workflow(e.g. Makefile, precommit hook, jenkins job).

Copy link
Contributor

@patacongo patacongo Dec 23, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That actually makes a lot of sense, is simpler, and sounds more flexible. I would tend to support Xiao Xiang's argument.

Since this has taken a different twist, should we unresolve the conversation?

Copy link
Contributor

@patacongo patacongo Dec 23, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unresolved only because I think we need to address Xiao Xiang's recommendation in some fashion. It would have been better if this were a separate comment.

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 @@ -697,3 +706,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
View file
Open in desktop
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.
#

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 master --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 $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
Loading