Allow for modules to show an arbitrary notice.

diff --git a/ChangeLog b/ChangeLog
index b66783b06dc7fdf21de85be23857c239c2cd388e..5db53d66e583101df3a800be72d9041e2322a5f0 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,15 @@
+2007-09-09  Bruno Haible  <bruno@clisp.org>
+
+       Allow for modules to show an arbitrary notice.
+       * modules/TEMPLATE-EXTENDED: Add 'Notice' field.
+       * gnulib-tool: New option --extract-notice.
+       (func_usage): Document it.
+       (sed_extract_prog): Update.
+       (func_get_notice): New function.
+       (func_modules_notice): New function.
+       (func_import, func_create_testdir): Invoke it.
+       Suggested by Jim Meyering.
+
 2007-09-09  Bruno Haible  <bruno@clisp.org>
 
        * gnulib-tool: New options --verbose, --quiet.

diff --git a/gnulib-tool b/gnulib-tool
index 16f49aa6bed375978472282b5ccfcd924c7df846..0810a5953c2654bff47a61e0a18086f0369c57b5 100755 (executable)
--- a/gnulib-tool
+++ b/gnulib-tool
@@ -22,7 +22,7 @@
 
 progname=$0
 package=gnulib
-cvsdatestamp='$Date: 2007-09-09 11:49:58 $'
+cvsdatestamp='$Date: 2007-09-09 12:17:36 $'
 last_checkin_date=`echo "$cvsdatestamp" | sed -e 's,^\$[D]ate: ,,'`
 version=`echo "$last_checkin_date" | sed -e 's/ .*$//' -e 's,/,-,g'`
 nl='
@@ -89,6 +89,7 @@ Usage: gnulib-tool --list
        gnulib-tool --test --dir=directory module1 ... moduleN
        gnulib-tool --megatest --dir=directory [module1 ... moduleN]
        gnulib-tool --extract-description module
+       gnulib-tool --extract-notice module
        gnulib-tool --extract-filelist module
        gnulib-tool --extract-dependencies module
        gnulib-tool --extract-autoconf-snippet module
@@ -114,6 +115,7 @@ Operation modes:
       --megatest            test the given modules one by one and all together
                             (recommended to use CC=\"gcc -Wall\" here)
       --extract-description        extract the description
+      --extract-notice             extract the notice or banner
       --extract-filelist           extract the list of files
       --extract-dependencies       extract the dependencies
       --extract-autoconf-snippet   extract the snippet for configure.ac
@@ -1142,6 +1144,7 @@ sed_extract_prog=':[       ]*$/ {
   :a
     n
     s/^Description:[    ]*$//
+    s/^Notice:[         ]*$//
     s/^Files:[  ]*$//
     s/^Depends-on:[     ]*$//
     s/^configure\.ac-early:[    ]*$//
@@ -1166,6 +1169,15 @@ func_get_description ()
   sed -n -e "/^Description$sed_extract_prog" < "$lookedup_file"
 }
 
+# func_get_notice module
+# Input:
+# - local_gnulib_dir  from --local-dir
+func_get_notice ()
+{
+  func_lookup_file "modules/$1"
+  sed -n -e "/^Notice$sed_extract_prog" < "$lookedup_file"
+}
+
 # func_get_filelist module
 # Input:
 # - local_gnulib_dir  from --local-dir
@@ -1444,6 +1456,27 @@ ba
   fi
 }
 
+# func_modules_notice
+# Input:
+# - local_gnulib_dir  from --local-dir
+# - verbose         integer, default 0, inc/decremented by --verbose/--quiet
+# - modules         list of modules, including dependencies
+func_modules_notice ()
+{
+  if test $verbose -ge -1; then
+    for module in $modules; do
+      func_verify_module
+      if test -n "$module"; then
+        msg=`func_get_notice $module`
+        if test -n "$msg"; then
+          echo "Notice from module $module:"
+          echo "$msg" | sed -e 's/^/  /'
+        fi
+      fi
+    done
+  fi
+}
+
 # func_modules_to_filelist
 # Input:
 # - local_gnulib_dir  from --local-dir
@@ -1463,7 +1496,6 @@ func_modules_to_filelist ()
   files=`for f in $files; do echo $f; done | LC_ALL=C sort -u`
 }
 
-
 # func_execute_command command [args...]
 # Executes a command.
 # Uses also the variables
@@ -2148,6 +2180,9 @@ func_import ()
     done
   fi
 
+  # Show banner notice of every module.
+  func_modules_notice
+
   # Determine script to apply to imported library files.
   sed_transform_lib_file=
   for module in $modules; do
@@ -3068,6 +3103,9 @@ func_create_testdir ()
   # Add the dummy module if needed.
   func_modules_add_dummy
 
+  # Show banner notice of every module.
+  func_modules_notice
+
   # Determine final file list.
   func_modules_to_filelist
   if test $verbose -ge 0; then
@@ -3749,6 +3787,16 @@ case $mode in
     done
     ;;
 
+  extract-notice )
+    for module
+    do
+      func_verify_module
+      if test -n "$module"; then
+        func_get_notice "$module"
+      fi
+    done
+    ;;
+
   extract-filelist )
     for module
     do

diff --git a/modules/TEMPLATE-EXTENDED b/modules/TEMPLATE-EXTENDED
index b2868d043e5c7f2c92cff56cc3acd2597fce0537..e0fe9bf2be0f7b4e53773b9e29e059a88fba8130 100644 (file)
--- a/modules/TEMPLATE-EXTENDED
+++ b/modules/TEMPLATE-EXTENDED
@@ -1,5 +1,7 @@
 Description:
 
+Notice:
+
 Files:
 
 Depends-on: