]> git.ipfire.org Git - thirdparty/libtool.git/commitdiff
* ChangeLog: Reformatting.
authorGary V. Vaughan <gary@gnu.org>
Sat, 8 Jan 2005 19:05:19 +0000 (19:05 +0000)
committerGary V. Vaughan <gary@gnu.org>
Sat, 8 Jan 2005 19:05:19 +0000 (19:05 +0000)
* HACKING: Fix section numbering.
(Editing 'ChangeLog'): New notes on ChangeLog entry format.

ChangeLog
HACKING

index ac31472322370f1e460ebc588ad6e59a4bcba75b..541f8a0cf72e25e1757e769e36d3a613bc9eaaad 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,15 +1,21 @@
+2005-01-08  Gary V. Vaughan  <gary@gnu.org>
+
+       * ChangeLog: Reformatting.
+       * HACKING: Fix section numbering.
+       (Editing 'ChangeLog'): New notes on ChangeLog entry format.
+
 2005-01-03  Ralf Wildenhues  <Ralf.Wildenhues@gmx.de>
 
        * tests/am-subdir.at tests/testsuite.at (AT_BOOTSTRAP,
-       AT_LIBTOOLIZE, AT_CHECK_LIBTOOLIZE) Rename to ..
-       (LT_AT_BOOTSTRAP, LT_AT_LIBTOOLIZE, LT_AT_CHECK_LIBTOOLIZE)
-       and make use of new names.
+       AT_LIBTOOLIZE, AT_CHECK_LIBTOOLIZE): Rename to ...
+       (LT_AT_BOOTSTRAP, LT_AT_LIBTOOLIZE, LT_AT_CHECK_LIBTOOLIZE):
+       ...and make use of new names.
 
 2004-12-30  Ralf Wildenhues  <Ralf.Wildenhues@gmx.de>
 
        * config/getopt.m4sh (func_version, func_usage, func_help):
        Use `$SED -n' instead of `$SED RANGE {..}; d' as AIX sed cannot
-       handle the latter.  
+       handle the latter.
        (func_help): start autoconf and automake in subshells to avoid
        error messages from ash or Bourne shell if not available.
 
 
        * Makefile.am, bootstrap, clcommit.m4sh, libtoolize.m4sh,
        config/ltmain.m4sh: Replace `set --' with `set dummy [...]; shift'
-       for portability.  tests/sh.test: Test for this.
+       for portability.
+       * tests/sh.test: Test for this.
 
 2004-12-28  Ralf Wildenhues  <Ralf.Wildenhues@gmx.de>
 
-       * libtoolize.m4sh, config/ltmain.m4sh (most functions):
-       New variable $opt_debug is either `:' or `set -x' depending on --debug.
-       Execute at most function entries to cater for ksh which resets `-x'.
+       * libtoolize.m4sh, config/ltmain.m4sh (most functions): New
+       variable $opt_debug is either `:' or `set -x' depending on
+       --debug.  Execute at most function entries to cater for ksh which
+       resets `-x'.
        * tests/defs.m4sh: Ditto for VERBOSE=debug.
 
-       * m4/libtool.m4 (_LT_LINKER_SHLIBS)
-       [cygwin, mingw, pw32 ]: _LT_TAGVAR missing for `fix_srcfile_path'.
-       [ sysv4, sysv5 ]: _LT_TAGVAR missing for `export_dynamic_flag_spec'.
+       * m4/libtool.m4 (_LT_LINKER_SHLIBS) [cygwin, mingw, pw32]:
+       _LT_TAGVAR missing for `fix_srcfile_path'.
+       [sysv4, sysv5]: _LT_TAGVAR missing for
+       `export_dynamic_flag_spec'.
 
        * doc/libtool.texi (all over): Use @option and @command.
        Some more minor formatting updates, typos.
 
-       * m4/libtool.m4 (_LT_PROG_ECHO_BACKSLASH): Fix variable
-       quoting; allows lt_ECHO to match --fallback-echo again.
+       * m4/libtool.m4 (_LT_PROG_ECHO_BACKSLASH): Fix variable quoting;
+       allows lt_ECHO to match --fallback-echo again.
 
        * config/ltmain.m4sh (func_extract_archives): Not all shells grok
        `read -r' (unnecessary in this case).
        Reported by Ralf Menzel <menzel@ls6.cs.uni-dortmund.de>.
 
-       * config/general.m4sh: New variable quote_scanset..
-       (func_quote_for_eval, func_quote_for_expand)  ..use it to work around
-       SunOS ksh `case' backslash-escaping bug: protect character class by
-       variable expansion.  Reported by Alexander Kurz <alexander.kurz@qsc.de>.
+       * config/general.m4sh: New variable quote_scanset...
+       (func_quote_for_eval, func_quote_for_expand): ...use it to work
+       around SunOS ksh `case' backslash-escaping bug: protect character
+       class by variable expansion.
+       Reported by Alexander Kurz <alexander.kurz@qsc.de>.
 
        * tests/quote.test: Restart under the correct shell (the one
        $ECHO was computed for).
 
 2004-12-20  Peter O'Gorman  <peter@pogma.com>
 
-       * config/ltmain.m4sh (func_extract_archives,func_extract_an_archive): 
-       On darwin, uniq can not take the flags -cd together, thanks to Ralf
-       for the fix, also ar does not accept N, so we use the fact that
-       ar x libfoo.a foo.o will always extract the first foo.o in the
-       archive and we then delete foo.o from the archive, which will also
-       delete only the first foo.o, then rinse and repeat. Also add markers
-       for the testuite.
-       * m4/libtool.m4 (_LT_CONFIG): Add a marker so that we can use a sed
-       expression to find the shell functions in libtool.
+       * config/ltmain.m4sh (func_extract_archives)
+       (func_extract_an_archive): On darwin, uniq can not take the flags
+       -cd together, thanks to Ralf for the fix, also ar does not accept
+       N, so we use the fact that ar x libfoo.a foo.o will always extract
+       the first foo.o in the archive and we then delete foo.o from the
+       archive, which will also delete only the first foo.o, then rinse
+       and repeat. Also add markers for the testuite.
+       * m4/libtool.m4 (_LT_CONFIG): Add a marker so that we can use a
+       sed expression to find the shell functions in libtool.
        * tests/functests.at: Test this feature.
        * tests/testsuite.at: Add the test.
        * tests/Makefile.am: Add the test.
 
 2004-12-20  Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
 
-       * libtoolize.m4sh: Install `install-sh' as well, needed for configure ..
-       * Makefile.am, Makefile.maint: .. install, update it.
-       * NEWS, doc/libtool.texi (Distributing): .. document it.
+       * libtoolize.m4sh: Install `install-sh' as well, needed for
+       configure.
+       * Makefile.am, Makefile.maint: Install, update it.
+       * NEWS, doc/libtool.texi (Distributing): Document it.
        Reported by Ross Boylan <ross@biostat.ucsf.edu>.
 
-       * m4/libtool.m4 [solaris] (_LT_LINKER_SHLIBS): Add '${wl}-z ${wl}text'
-       to archive_cmds and archive_expsyms_cmds.  I.e., do not allow nopic in
-       shared libraries.
+       * m4/libtool.m4 (_LT_LINKER_SHLIBS) [solaris]: Add '${wl}-z
+       ${wl}text' to archive_cmds and archive_expsyms_cmds.  I.e., do not
+       allow nopic in shared libraries.
 
-       * m4/libtool.m4 [solaris] (_LT_LINKER_SHLIBS): Change no_undefined_flag
-       back to ' -z defs'.  Problems with linking against libgcc.a will have
-       to be resolved differently.
+       * m4/libtool.m4 (_LT_LINKER_SHLIBS) [solaris]: Change
+       no_undefined_flag back to ' -z defs'.  Problems with linking
+       against libgcc.a will have to be resolved differently.
 
        * tests/demo-nopic.test [solaris, sunos]: Skip test.
 
        * libtool.m4 [linux] (_LT_COMPILER_PIC, _LT_LANG_CXX_CONFIG):
        Match icpc* and ecpc* (ia64 version of icpc) instead of only icpc.
 
-       * libltdl/lt__dirent.c [mingw] (opendir): Fix write of constant
+       * libltdl/lt__dirent.c (opendir) [mingw]: Fix write of constant
        strings past end of buffer.
        (opendir, readdir): Fix read past end of buffer.
 
 2004-12-13  Albert Chin-A-Young  <china@thewrittenword.com>
 
        * libtool.m4 (_LT_LINKER_SHLIBS, _LT_LANG_CXX_CONFIG):
-       Append -G to link command-line on AIX to honor -brtl on command-line
-       (runtime linking). Already done for IBM C/C++ compilers.
+       Append -G to link command-line on AIX to honor -brtl on
+       command-line (runtime linking). Already done for IBM C/C++
+       compilers.
 
 2004-12-12  Patrick Welche <prlw1@newn.cam.ac.uk>
 
 2004-12-10  Ralf Wildenhues  <Ralf.Wildenhues@gmx.de>
 
        * config/ltmain.m4sh (func_extract_archive): Send stderr of $NM
-       to /dev/null.  Reported by Martin Waitz <tali@admingilde.org>.
+       to /dev/null.
+       Reported by Martin Waitz <tali@admingilde.org>.
 
 2004-12-09  Albert Chin-A-Young  <china@thewrittenword.com>
 
 
 2004-12-09  Ralf Wildenhues  <Ralf.Wildenhues@gmx.de>
 
-       * config/ltmain.m4sh (func_mode_finish) [solaris]: Fix [] escaping bug.
+       * config/ltmain.m4sh (func_mode_finish) [solaris]: Fix [] escaping
+       bug.
 
-       * config/ltmain.m4sh (all over the map): Make use of func_basename and
-       func_dirname in most occasions.
+       * config/ltmain.m4sh (all over the map): Make use of func_basename
+       and func_dirname in most occasions.
 
-       * m4/libtool.m4 (_LT_CHECK_XSI_SHELL, _LT_PROG_XSI_SHELLFNS): New macros
-       to detect at `configure' time whether the shell supports some XSI
-       extensions and to copy appropriate versions of new shell functions into
-       `libtool' through `config.status'.  Copied functions are Bourne and XSI
-       variants of func_basename, func_dirname (a variant of `dirname' suitable
-       for libtool).  (_LT_SETUP) Require _LT_CHECK_XSI_SHELL.
-       (_LT_CONFIG)  Use _LT_PROG_XSI_SHELLFNS to insert into `libtool' at marker.
+       * m4/libtool.m4 (_LT_CHECK_XSI_SHELL, _LT_PROG_XSI_SHELLFNS): New
+       macros to detect at `configure' time whether the shell supports
+       some XSI extensions and to copy appropriate versions of new shell
+       functions into `libtool' through `config.status'.  Copied
+       functions are Bourne and XSI variants of func_basename,
+       func_dirname (a variant of `dirname' suitable for libtool).
+       (_LT_SETUP): Require _LT_CHECK_XSI_SHELL.
+       (_LT_CONFIG):  Use _LT_PROG_XSI_SHELLFNS to insert into `libtool'
+       at marker.
 
        * config/ltmain.m4sh: Set marker for insertion of shell functions.
 
 2004-11-29  Ralf Wildenhues  <Ralf.Wildenhues@gmx.de>
 
        * config/ltmain.m4sh (func_lalib_p): Update function
-       description. (func_lalib_unsafe_p): New function with same
-       functionality but written without forks; this function is safe
-       to use for cases where the argument either does not exist or
-       is required to be a lalib for correct operation.
+       description.
+       (func_lalib_unsafe_p): New function with same functionality but
+       written without forks; this function is safe to use for cases
+       where the argument either does not exist or is required to be a
+       lalib for correct operation.
        * NEWS: Mention the fact that stdin is not to be used.
-       * (func_mode_execute, func_mode_install, func_mode_link):
-       Use func_lalib_unsafe_p where appropriate.
-       (func_mode_execute): For the program wrapper, use
+       * config/ltmain.m4sh (func_mode_execute, func_mode_install)
+       (func_mode_link): Use func_lalib_unsafe_p where appropriate.
+       (func_mode_execute): For the program wrapper, use
        func_ltwrapper_p instead of func_lalib_p.
 
        * m4/libtool.m4 (_LT_LINKER_SHLIBS): Treat linux-dietlibc with
-       the `diet' compiler wrapper (as opposed to the `diet-dyn'
-       wrapper) as a static-only platform.
+       the `diet' compiler wrapper (as opposed to the `diet-dyn' wrapper)
+       as a static-only platform.
        * NEWS: Updated.
 
        * libltdl/ltdl.c (trim): Use memcpy instead of strncpy here, to
 
 2004-11-24  Jeff Squyres  <jsquyres@lam-mpi.org>
 
-       * m4/libtool.m4 [linux] (_LT_COMPILER_PIC, _LT_LINKER_SHLIBS,
-       _LT_LANG_CXX_CONFIG), NEWS, THANKS: Support for Portland Group
-       (aka "pgi") compilers.
+       * m4/libtool.m4 (_LT_COMPILER_PIC, _LT_LINKER_SHLIBS)
+       (_LT_LANG_CXX_CONFIG) [linux]: Support for Portland Group (aka
+       "pgi") compilers.
+       * NEWS, THANKS: Updated.
 
 2004-11-24  Gary V. Vaughan  <gary@gnu.org>
 
 
 2004-11-18  Ralf Wildenhues  <Ralf.Wildenhues@gmx.de>
 
-       * m4/libtool.m4 (_LT_LINKER_SHLIBS) [cygwin/mingw/pw32]:
+       * m4/libtool.m4 (_LT_LINKER_SHLIBS) [cygwin, mingw, pw32]:
        tag-protect setting of ld_shlibs.
 
 2004-11-17  Ralf Wildenhues  <Ralf.Wildenhues@gmx.de>
 2004-11-17  Mats Rynge  <rynge@isi.edu>
 
        * libtool.m4 [linux]: Use only the CC basename in case statment
-       when checking for icc/ecc. Allows for setting CC to the full path
+       when checking for icc/ecc.  Allows for setting CC to the full path
        to the compiler.
 
        * libtool.m4 [solaris]: Added missing 'with linker' flags to
        Fix error message with `-objectlist' file that does not exist.
        * tests/objectlist.test:  New test for this.
 
-       * Makefile.am: config/ltmain.sh is generated by config/ltmain.m4sh.
+       * Makefile.am: config/ltmain.sh is generated by
+       config/ltmain.m4sh.
 
 2004-11-09  Ralf Wildenhues  <Ralf.Wildenhues@gmx.de>
 
diff --git a/HACKING b/HACKING
index 3596cca0f53968a2e479083ccb1a70434994e0a6..90ae96c08345ea5d51e895ffd825a3cdce77ec91 100644 (file)
--- a/HACKING
+++ b/HACKING
@@ -48,14 +48,14 @@ and is not part of a release distribution.
 * Changes other than bug fixes must be mentioned in NEWS
 
 
-2. Test Suite
+3. Test Suite
 =============
 
 * Use "make check" liberally, on as many platforms as you can.  Use as
   many compilers and linkers you can.
 
 
-3. Naming
+4. Naming
 =========
 
 * We've adopted the convention that exported Autoconf macros should be
@@ -71,7 +71,102 @@ and is not part of a release distribution.
   with the `_lt_' macro namespace).
 
 
-4. Editing `.am' Files
+5. Editing 'ChangeLog'
+======================
+
+* When in doubt, check that emacs can syntax-color properly in
+  change-log-mode.  And preferably use emacs 'C-x 4 a'
+  (add-change-log-entry-other-window) to open ChangeLog with an
+  appropriate new template.
+
+* If this change is by a different author, or on a different date to the
+  last entry start a new entry at the top of the file with the format
+  (note two spaces between each field):
+
+yyyy-mm-dd  Name of Author  <email@address>
+
+* 'Name of Author' is the name of the person who made the change being
+  documented, or if that person didn't supply a ChangeLog, the author
+  of the ChangeLog entry.  If more than one person collaborated on the
+  change, additional authors can be listed on subsequent lines, thus:
+
+yyyy-mm-dd  Name of Main Author  <email@address>,
+            Name of Contributor  <another@email.address>
+
+* Preferably the next part should be a description of the overall
+  purpose of the change, separated from the header by a blank line,
+  indented by 1 tab, and filled at column 72.  The last character of the
+  description should be a colon, :.
+
+* If the author of the change is different from the author of the
+  ChangeLog, then the change outhor should be credited, separated from
+  the previous field by a blank line and indented by 1 tab (note, only
+  1 space between fields here):
+
+       From Author of Actual Change <email@address>:
+
+* Changes to each file come next.  Each new file starts on a new line,
+  indented by 1 tab and starting with an asterisk and a space.  Multiple
+  files can be listed here relative to $top_srcdir, and comma separated.
+  Names of functions (or sections as appropriate) to which the change
+  applies should be named inside parentheses and comma separated.  If
+  this goes beyond column 72, then parens should be closed and re-opened
+  on the next line:
+
+       * file, another/file, test/testcases/foo.test (func_foo)
+       (func_bar, func_baz): Description of changes.
+
+* If the change does not apply to particular functions (or sections),
+  the section list can be omitted:
+
+       * file, another/file, test/testcases/foo.test: General changes.
+
+* If the changes are particular to certain architectures, they should be
+  listed after the functions in square brackets:
+
+       * file, another/file (func_foo) [linux, solaris]: Description of
+       changes.
+
+* Subsequent changes in other files that are related to the same overall
+  enhancement or bugfix should be listed concurrently, without blank
+  lines.  Always start a fresh line for a new file:
+
+       * file, another/file (func_foo) [linux, solaris]: Description of
+       changes.
+       * doc/foo.texi (Invoking Foo): Document.
+       * NEWS: Updated.
+
+* If the change is in response to a problem reported by someone other
+  than the author, then credit them at the end of the description with:
+
+       Reported by Reporter Name <email@address>.
+
+* See the GNU Coding Standards document for more details on ChangeLog
+  formatting.
+
+
+2005-01-08  Gary V. Vaughan  <gary@gnu.org>,
+            Peter O'Gorman  <peter@pogma.com>
+
+       This is the overall description of the purpose of this change
+       and any useful background for a model ChangeLog entry:
+
+       From Ralf Wildenhues <Ralf.Wildenhues@gmx.de>:
+       * HACKING: Updated copyright.  This isn't attached to a
+       particular section of the file, so it comes first.
+       (Editing 'ChangeLog'): New section.  This applies to the same
+       file, but since it applies to a particular section it starts on
+       a new line.
+       (Introduction, Maintenance Notes, Test Suite, Naming)
+       (Editing '.am' Files): If I had changed all these sections in
+       the same way, I can list them like this, being careful to close
+       and reopen the parentheses when starting a new line.  The colon
+       only comes after the last section before this description.
+       * NEWS: Updated.
+       Reported by Bob Friesenhahn <bfriesen@simple.dallas.tx.us>.
+
+
+6. Editing `.am' Files
 ======================
 
 * Always use $(...) and not ${...}
@@ -89,7 +184,7 @@ and is not part of a release distribution.
   of the loop itself should print each "important" command it runs.
 
 
-5. Editing `.m4sh' Files
+7. Editing `.m4sh' Files
 ========================
 
 * Use shell functions, but be careful not to assume local scope for
@@ -110,7 +205,7 @@ and is not part of a release distribution.
   functions should begin indented by 4 spaces.
 
 
-6. Abstraction layers in libltdl
+8. Abstraction layers in libltdl
 ================================
 
 * The libltdl API uses a layered approach to differentiate internal and
@@ -194,7 +289,7 @@ and is not part of a release distribution.
        lt__private.h
 
 
-7. Release Procedure
+9. Release Procedure
 ====================
 
 * If you are a libtool maintainer, but have not yet registered your
@@ -281,8 +376,8 @@ and is not part of a release distribution.
 
 
 
-7. Alpha release note template
-==============================
+10. Alpha release note template
+===============================
 
 To: libtool@gnu.org, autotools-announce@gnu.org
 Subject: GNU Libtool @VERSION@ released (alpha release).
@@ -354,8 +449,8 @@ output of any failed test groups, and the output from `./libtool --help.'
 
 
 
-8. Full release note template
-=============================
+11. Full release note template
+==============================
 
 To: info-gnu@gnu.org
 Cc: libtool@gnu.org, autotools-announce@gnu.org
@@ -436,7 +531,7 @@ output of any failed test groups, and the output from `./libtool --help.'
 
 
 -- 
-Copyright (C) 2004 Free Software Foundation, Inc.
+Copyright (C) 2004, 2005 Free Software Foundation, Inc.
 
 The canonical source of this file is maintained with the
 GNU Libtool package.  Report bugs to bug-libtool@gnu.org.