[tor-commits] [tor/master] Makefile/git scripts: Add comments to keep owned file lists in sync

[teor at torproject.org]

commit ac3a9aaf0dc6f376368f1ad51c79e332da52adc2
Author: teor <teor at torproject.org>
Date:   Tue Nov 26 09:20:57 2019 +1000

    Makefile/git scripts: Add comments to keep owned file lists in sync
---
 Makefile.am                             | 4 ++++
 scripts/coccinelle/check_cocci_parse.sh | 4 ++++
 scripts/git/pre-commit.git-hook         | 4 ++++
 scripts/git/pre-push.git-hook           | 6 +++++-
 4 files changed, 17 insertions(+), 1 deletion(-)

diff --git a/Makefile.am b/Makefile.am
index 2dd3a7aa3..811694f0b 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -389,6 +389,10 @@ coverage-html-full: all
 	genhtml --branch-coverage -o "$(HTML_COVER_DIR)" "$(HTML_COVER_DIR)/lcov.info"
 
 # For scripts: avoid src/ext and src/trunnel.
+# Keep these lists consistent:
+#   - OWNED_TOR_C_FILES in Makefile.am
+#   - CHECK_FILES in pre-commit.git-hook and pre-push.git-hook
+#   - try_parse in check_cocci_parse.sh
 OWNED_TOR_C_FILES=\
 		$(top_srcdir)/src/lib/*/*.[ch] \
 		$(top_srcdir)/src/core/*/*.[ch] \
diff --git a/scripts/coccinelle/check_cocci_parse.sh b/scripts/coccinelle/check_cocci_parse.sh
index aebfac70f..aaa586c09 100755
--- a/scripts/coccinelle/check_cocci_parse.sh
+++ b/scripts/coccinelle/check_cocci_parse.sh
@@ -73,6 +73,10 @@ if test $# -ge 1 ; then
 else
   cd "$top" || exit 1
   # This is the layout in 0.3.5
+  # Keep these lists consistent:
+  #   - OWNED_TOR_C_FILES in Makefile.am
+  #   - CHECK_FILES in pre-commit.git-hook and pre-push.git-hook
+  #   - try_parse in check_cocci_parse.sh
   "$try_parse" \
     src/lib/*/*.[ch] \
     src/core/*/*.[ch] \
diff --git a/scripts/git/pre-commit.git-hook b/scripts/git/pre-commit.git-hook
index 95d566b17..d5a75f279 100755
--- a/scripts/git/pre-commit.git-hook
+++ b/scripts/git/pre-commit.git-hook
@@ -19,6 +19,10 @@ if [ $# -eq 0 ]; then
     # Use the appropriate owned tor source list to filter the changed files
     if [ -d src/lib ]; then
         # This is the layout in 0.3.5
+        # Keep these lists consistent:
+        #   - OWNED_TOR_C_FILES in Makefile.am
+        #   - CHECK_FILES in pre-commit.git-hook and pre-push.git-hook
+        #   - try_parse in check_cocci_parse.sh
         CHECK_FILES="$($CHECK_FILTER \
                            src/lib/*/*.[ch] \
                            src/core/*/*.[ch] \
diff --git a/scripts/git/pre-push.git-hook b/scripts/git/pre-push.git-hook
index 6a85e951a..8b5efb0a9 100755
--- a/scripts/git/pre-push.git-hook
+++ b/scripts/git/pre-push.git-hook
@@ -65,6 +65,10 @@ do
             # files
             if [ -d src/lib ]; then
                 # This is the layout in 0.3.5
+                # Keep these lists consistent:
+                #   - OWNED_TOR_C_FILES in Makefile.am
+                #   - CHECK_FILES in pre-commit.git-hook and pre-push.git-hook
+                #   - try_parse in check_cocci_parse.sh
                 CHECK_FILES="$($CHECK_FILTER \
                                    src/lib/*/*.[ch] \
                                    src/core/*/*.[ch] \
@@ -81,7 +85,7 @@ do
                                    src/or/*/*.[ch] \
                                    src/test/*.[ch] \
                                    src/test/*/*.[ch] \
-                                   src/tools/*.[ch]
+                                   src/tools/*.[ch] \
                               )"
             fi