Teach check-header.sh to ensure that the first included header in .c
files is either git-compat-util.h, builtin.h, or cache.h.
Ensure that common-cmds.h is only included by help.c.
Move the logic into functions so that we can skip parts of the check.
Signed-off-by: David Aguilar <davvid@xxxxxxxxx>
---
This depends on my previous patch that adds check-header.sh.
check-headers.sh | 66 +++++++++++++++++++++++++++++++++++++++++++++++++++-----
1 file changed, 61 insertions(+), 5 deletions(-)
diff --git a/check-headers.sh b/check-headers.sh
index ef06f56..7f25e7a 100755
--- a/check-headers.sh
+++ b/check-headers.sh
@@ -1,5 +1,9 @@
#!/bin/sh
+# This script is run via make.
+# "make check-headers SKIP_HEADER_CHECK=1" skips the header dependency check.
+# "make check-headers SKIP_USAGE_CHECK=1" skips the header usage check.
+
exit_code=0
maybe_exit () {
@@ -14,11 +18,11 @@ maybe_exit () {
fi
}
-for header in *.h ewah/*.h vcs-svn/*.h xdiff/*.h
-do
+check_header () {
+ header="$1"
case "$header" in
common-cmds.h)
- # should only be included by help.c
+ # should only be included by help.c, not checked
;;
*)
subdir=$(dirname "$header") &&
@@ -29,6 +33,58 @@ do
maybe_exit $?
;;
esac
-done
+}
+
+check_headers () {
+ for header in *.h ewah/*.h vcs-svn/*.h xdiff/*.h
+ do
+ check_header "$header"
+ done
+}
+
+check_header_usage () {
+ first=$(grep '^#include' "$1" |
+ head -n1 |
+ sed -e 's,#include ",,' -e 's,"$,,')
+
+ case "$first" in
+ cache.h|builtin.h|git-compat-util.h)
+ # happy
+ ;;
+ *)
+ echo "error: $1 must #include \"git-compat-util.h\" before $first"
+ maybe_exit 1
+ ;;
+ esac
+
+ if grep common-cmds.h "$1" >/dev/null && test "$1" != help.c
+ then
+ echo "error: $1 must not include common-cmds.h"
+ maybe_exit 1
+ fi
+}
+
+check_usage () {
+ # Implementation files should #include git-compat-util.h, cache.h,
+ # or builtin.h before any others.
+ for impl in *.c builtin/*.c
+ do
+ check_header_usage "$impl"
+ done
+}
+
+main () {
+ if test -z "$SKIP_HEADER_CHECK"
+ then
+ check_headers "$@"
+ fi
+
+ if test -z "$SKIP_USAGE_CHECK"
+ then
+ check_usage
+ fi
+
+ exit $exit_code
+}
-exit $exit_code
+main "$@"
--
2.1.0.241.ga16d620
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html