From: The Squid Software Foundation <>
Date: Thu, 3 Oct 2013 17:28:29 +0000 (-0600)
Subject: Restricted script scope to boiler management. Polished description.
X-Git-Tag: SQUID_3_5_0_1~98^2~11
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=0910221a08b007c7a9e742a3ea949c33d3bf830e;p=thirdparty%2Fsquid.git

Restricted script scope to boiler management. Polished description.
---

diff --git a/scripts/source-mangler.pl b/scripts/boiler-mgr.pl
similarity index 91%
rename from scripts/source-mangler.pl
rename to scripts/boiler-mgr.pl
index 597dbadc5e..1ea77c536a 100755
--- a/scripts/source-mangler.pl
+++ b/scripts/boiler-mgr.pl
@@ -1,11 +1,17 @@
 #!/usr/bin/perl -w
 
-# Adds or adjust the source file boilerplate, such as a Copyright statement.
-# The boilerplate does not change from one source file to another and is
-# assumed to be the first /* comment */ in a source file, before
-# the first #include statement.
+# Adds or adjusts the source file boilerplate, such as a Copyright statement.
+# The boilerplate is meant to remain constant from one source file to another.
 #
-# TODO: Adjust ifndef/define/endif guards for source header files as well.
+# The old boilerplate is assumed to be the first /* comment */ in a source 
+# file, before the first #include statement other than #include "squid.h".
+# Common old boilerplates are removed, with Copyright claims contained in
+# them logged on stdout for recording in CONTRIBUTORS or some such.
+#
+# The new boilerplate comment is placed at the very beginning of the file.
+#
+# The script tries hard to detect files with unusual old boilerplates. When
+# detected, the script warns about the problem and leaves the file "as is".
 
 use strict;
 use warnings;