[Cvs-cvs] ccvs/windows-NT ChangeLog mkconfig.pl

[Derek Robert Price]

CVSROOT:        /cvsroot/cvs
Module name:    ccvs
Changes by:     Derek Robert Price <dprice>     06/06/11 15:53:18

Modified files:
        windows-NT     : ChangeLog mkconfig.pl 

Log message:
        * mkconfig.pl: Add a script comment block.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/ccvs/windows-NT/ChangeLog?cvsroot=cvs&r1=1.356&r2=1.357
http://cvs.savannah.gnu.org/viewcvs/ccvs/windows-NT/mkconfig.pl?cvsroot=cvs&r1=1.9&r2=1.10

Patches:
Index: ChangeLog
===================================================================
RCS file: /cvsroot/cvs/ccvs/windows-NT/ChangeLog,v
retrieving revision 1.356
retrieving revision 1.357
diff -u -b -r1.356 -r1.357
--- ChangeLog   23 May 2006 17:31:56 -0000      1.356
+++ ChangeLog   11 Jun 2006 15:53:16 -0000      1.357
@@ -1,3 +1,7 @@
+2006-06-11  Derek Price  <address@hidden>
+
+       * mkconfig.pl: Add a script comment block.
+
 2006-05-23  Mark D. Baushke  <address@hidden>
 
        * filesubr.c: Reformat according to HACKING standards.

Index: mkconfig.pl
===================================================================
RCS file: /cvsroot/cvs/ccvs/windows-NT/mkconfig.pl,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -b -r1.9 -r1.10
--- mkconfig.pl 9 Mar 2005 19:55:51 -0000       1.9
+++ mkconfig.pl 11 Jun 2006 15:53:17 -0000      1.10
@@ -1,5 +1,46 @@
 #! perl -w
 
+# This file constructs the Windows config.h.in file, from the parent
+# config.h.in file and some source files in the windows-NT directory.  Run it
+# something like this:
+#
+#     ./mkconfig.pl ../config.h.in ./config.h.in.in ./config.h.in.footer
+#
+# If you don't like the resulting config.h.in (or config.h), #define a new
+# value in ./config.h.in.in, copying the template from ../config.h.in if you
+# like, or, if there is no template there and you are really sure you need the
+# value defined in config.h (system configuration data goes here), then put
+# the data in ./config.h.in.footer.
+#
+#
+# The deeper picture looks something like this:
+#
+# config.h.in -----------------------\
+#                                    +--(mkconfig.pl)--> windows-NT/config.h.in
+# windows-NT/config.h.in.in -----\   /
+#                                +--/
+# windows-NT/config.h.in.footer -/
+#
+#
+# windows-NT/config.h.in.in is interpreted, with #undef and #define replacing
+# similar directives from the parent config.h.in.  If no directive exists in
+# windows-NT/config.h.in.in corresponding to one from config.h.in, then a
+# warning will be issued to help developers decide what needs research and
+# definition.
+#
+# windows-NT/config.h.in.footer is copied verbatim to the end of
+# windows-NT/config.h.in.
+#
+# Of course, the complete picture is more complicated.  The windows-NT/config.h
+# file the Windows sources eventually include is actually generated by running
+# the UNIX configure script in the parent directory, usually under UNIX.  This
+# only replaces the PACKAGE_STRING and PACKAGE_BUGREPORT macros, whose values
+# can't be determined until the configure script is run.
+#
+# Of course, the parent config.h.in and configure files are themselves
+# generated by the autoheader and autoconf scripts from the configure.in file,
+# but dig into the autoconf manual if you want to know about that process.
+
 use strict;
 
 # For the `mv' function which is smart enough to cross device boundries.