From: Alex Rousskov <rousskov@measurement-factory.com>
Date: Thu, 4 Mar 2021 02:51:18 +0000 (+0000)
Subject: Maintenance: Make boilerplate copyright years update optional (#782)
X-Git-Tag: 4.15-20210522-snapshot~26
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=e73ef62a8f0c6d744a49e68fe2f764b9d80c4b78;p=thirdparty%2Fsquid.git

Maintenance: Make boilerplate copyright years update optional (#782)

Running with `--check-and-update-copyright no` allows developers to
format sources and/or perform other essential source maintenance actions
without changing the copyright year in 2000+ files.

No change to default ./scripts/source-maintenance.sh operation.

Also improved/updated scripts/source-maintenance.sh usage reporting and
added support for --help/-h options.
---

diff --git a/scripts/source-maintenance.sh b/scripts/source-maintenance.sh
index 163a827c48..3e468c6032 100755
--- a/scripts/source-maintenance.sh
+++ b/scripts/source-maintenance.sh
@@ -36,6 +36,17 @@ KeepGoingDirective=""
 TargetAstyleVersion="2.04"
 ASTYLE='astyle'
 
+# whether to check and, if necessary, update boilerplate copyright years
+CheckAndUpdateCopyright=yes
+
+printUsage () {
+    echo "Usage: $0 [option...]"
+    echo "options:"
+    echo "    --keep-going|-k"
+    echo "    --check-and-update-copyright <yes|no>"
+    echo "    --with-astyle </path/to/astyle/executable>"
+}
+
 # command-line options
 while [ $# -ge 1 ]; do
     case "$1" in
@@ -44,13 +55,27 @@ while [ $# -ge 1 ]; do
         KeepGoingDirective=$1
         shift
         ;;
+    --check-and-update-copyright)
+        if test "x$2" != xyes -a "x$2" != xno
+        then
+            printUsage
+            echo "Error: Option $1 expects a yes or no argument but got $2"
+            exit 1;
+        fi
+        CheckAndUpdateCopyright=$2
+        shift 2
+        ;;
+    --help|-h)
+        printUsage
+        exit 0;
+        ;;
     --with-astyle)
         ASTYLE=$2
         export ASTYLE
         shift 2
         ;;
     *)
-        echo "Usage: $0 [--keep-going|-k]"
+        printUsage
         echo "Unsupported command-line option: $1"
         exit 1;
         ;;
@@ -95,8 +120,11 @@ else
 	echo "Found astyle ${ASVER}. Formatting..."
 fi
 
-COPYRIGHT_YEARS=`date +"1996-%Y"`
-echo "s/1996-2[0-9]+ The Squid Software Foundation and contributors/${COPYRIGHT_YEARS} The Squid Software Foundation and contributors/g" >>boilerplate_fix.sed
+if test $CheckAndUpdateCopyright = yes
+then
+    COPYRIGHT_YEARS=`date +"1996-%Y"`
+    echo "s/1996-2[0-9]+ The Squid Software Foundation and contributors/${COPYRIGHT_YEARS} The Squid Software Foundation and contributors/g" >> boilerplate_fix.sed
+fi
 
 # executes the specified command
 # in KeepGoing mode, remembers errors and hides them from callers
@@ -312,7 +340,7 @@ for FILENAME in `git ls-files`; do
     esac
 
     # check for Foundation copyright blurb
-    if test -f ${FILENAME} -a "x$skip_copyright_check" = "x"; then
+    if test $CheckAndUpdateCopyright = yes -a -f ${FILENAME} -a "x$skip_copyright_check" = "x"; then
         BLURB=`grep -o "${COPYRIGHT_YEARS} The Squid Software Foundation and contributors" ${FILENAME}`;
         if test "x${BLURB}" = "x"; then
             BOILER=`grep -o -E "1996-2[0-9]+ The Squid Software Foundation and contributors" ${FILENAME}`;
@@ -383,6 +411,6 @@ srcFormat || exit 1
 sort -u <doc/debug-sections.tmp | sort -n >doc/debug-sections.tmp2
 cat scripts/boilerplate.h doc/debug-sections.tmp2 >doc/debug-sections.txt
 rm doc/debug-sections.tmp doc/debug-sections.tmp2
-rm boilerplate_fix.sed
+rm -f boilerplate_fix.sed
 
 exit $SeenErrors