Re: 09-autotest-independence.patch

[Akim Demaille]

| On Friday 17 August 2001 12:47 pm, Akim Demaille wrote:
| > Index: ChangeLog
| > from ?Akim Demaille ?<address@hidden>
| >
| > ????????others.at no longer depends on other-tests/.
| >
| > ????????* tests/others.at (stackovf): You're actually...
| > ????????(sync-lines): this.
| > ????????(modfreeze, modpath1, modpath2, modpath3, modpath4, modtest,
| > shadow) (unload.test): Keep their authorship.
| > ????????(discard-comments, gmp, import-environment, modfreeze)
| > ????????(sync-lines): Embed the input files.
| > ????????* tests/stackovf.test: Copy from other-tests/stackovf.test.
| > ????????* tests/iso8850.m4: Copy from other-tests/iso8859.m4.
| 
| Seems we are each writing our ChangeLog entries in a different style =(O|
| 
| I don't mind which style we use, as long as it is consistent throughout the 
| whole ChangeLog.  It is probably less work to convert your log entries to the 
| existing style than vice vera though...
| 
| Here's a description of the rules I have been following:
| 
|   i) Emacs-21 style header (yyyy-mm-dd  <Name>  <email>)
|      Only add a new header if the date or the author is different from the
|      current top header.  The name used is the name of the person who wrote
|      the ChangeLog entry -- this matters if someone sends a patch without a
|      ChangeLog.
|  ii) Blank line.
| iii) `<tab>From <Name> <email>:' if the patch described beneath was submitted
|      by someone other than the person named in the header.
|  iv) Optional description of the purpose of the patch, with each line
|      indented by a single tab.  No leading `*'.
|   v) Changes.
|      `<tab>* <Filename>: <global changes description>.
|      `<tab>(<function list>) [host triplet globs]: <description>'
|      `<tab><description continuation>.'
|  vi) `<tab>Reported by <Name> <email>' if this fixes a reported bug.
| vii) Only insert blank lines between entries from distinct commits.
| 
| If you agree with this, I'll work it into the maintainers-page (to be).  
| Comments?

I think I basically follow your rules, but for white lines: I don't
like separating different checkins with a single empty line.  When
there are things which are very interrelated, but different, I like to
make it explicit.  For instance on Autoconf:

2001-08-01  Akim Demaille  <address@hidden>

        * lib/autoconf/lang.m4 (AC_LANG(C), AC_LANG_C, _AC_LANG_ABBREV(C))
        (AC_LANG(C++), AC_LANG_CPLUSPLUS, _AC_LANG_ABBREV(C++))
        (AC_LANG_SOURCE(C), AC_LANG_PROGRAM(C), AC_LANG_CALL(C))
        (AC_LANG_FUNC_LINK_TRY(C), AC_LANG_BOOL_COMPILE_TRY(C))
        (AC_LANG_INT_SAVE(C), _AC_ARG_VAR_CPPFLAGS, _AC_ARG_VAR_LDFLAGS)
        (AC_LANG_PREPROC(C), _AC_PROG_PREPROC_WORKS_IFELSE, AC_PROG_CPP)
        (AC_LANG_COMPILER(C), ac_cv_prog_gcc, AC_PROG_CC, _AC_PROG_CC_G)
        (AC_PROG_GCC_TRADITIONAL, AC_PROG_CC_C_O, AC_LANG_PREPROC(C++))
        (AC_PROG_CXXCPP, AC_LANG_COMPILER(C++), ac_cv_prog_gxx)
        (AC_PROG_CXX, _AC_PROG_CXX_G, _AC_PROG_CXX_EXIT_DECLARATION)
        (AC_PROG_CC_STDC, AC_C_CROSS, AC_C_CHAR_UNSIGNED, AC_C_LONG_DOUBLE)
        (AC_C_BIGENDIAN, AC_C_INLINE, AC_C_CONST, AC_C_VOLATILE)
        (AC_C_STRINGIZE, AC_C_PROTOTYPES): Move to...
        * lib/autoconf/c.m4: here, new file.

        * lib/autoconf/lang.m4 (AC_LANG(Fortran 77), AC_LANG_FORTRAN77)
        (_AC_LANG_ABBREV(Fortran 77), AC_LANG_SOURCE(Fortran 77))
        (AC_LANG_PROGRAM(Fortran 77), AC_LANG_CALL(Fortran 77))
        (AC_LANG_PREPROC(Fortran 77), AC_LANG_COMPILER(Fortran 77))
        (ac_cv_prog_g77, AC_PROG_F77, _AC_PROG_F77_G, AC_PROG_F77_C_O)
        (_AC_PROG_F77_V_OUTPUT, _AC_PROG_F77_V, AC_F77_LIBRARY_LDFLAGS)
        (AC_F77_DUMMY_MAIN, _AC_LANG_PROGRAM_C_F77_HOOKS, AC_F77_MAIN)
        (_AC_F77_NAME_MANGLING, AC_F77_NAME_MANGLING, AC_F77_WRAPPERS)
        (AC_F77_FUNC): Move to...
        * lib/autoconf/fortran.m4: here, new file.

2001-08-01  Akim Demaille  <address@hidden>

        * acfunctions.m4: Rename as...
        * lib/autoconf/functions.m4: this.
        * acgeneral.m4: Rename as...
        * lib/autoconf/general.m4: this.
        * acheaders.m4: Rename as...
        * lib/autoconf/headers.m4: this.
        * aclang.m4: Rename as...
        * lib/autoconf/lang.m4: this.
        * acoldnames.m4: Rename as...
        * lib/autoconf/oldnames.m4: this.
        * acspecific.m4: Rename as...
        * lib/autoconf/specific.m4: this.
        * actypes.m4: Rename as...
        * lib/autoconf/types.m4: this.
        * autoconf.m4: Rename as...
        * lib/autoconf/autoconf.m4: this.

        * m4sugar.m4: Rename as...
        * lib/m4sugar/m4sugar.m4: this.
        * m4sh.m4: Rename as...
        * lib/m4sugar/m4sh.m4: this.

        * tests/atgeneral.m4: Rename as...
        * lib/autotest/general.m4: this.

        * acfunctions: Rename as...
        * lib/autoscan/functions: this.
        * acheaders: Rename as...
        * lib/autoscan/headers: this.
        * acidentifiers: Rename as...
        * lib/autoscan/identifiers: this.
        * aclibraries: Rename as...
        * lib/autoscan/libraries: this.
        * acmakevars: Rename as...
        * lib/autoscan/makevars: this.
        * acprograms: Rename as...
        * lib/autoscan/programs: this.

2000-12-06  Akim Demaille  <address@hidden>

        The SunOS' egrep fails to process properly the `egrep' invocations
        of the test suite.

        * tests/aclocal.m4 (AC_STATE_SAVE): If egrep fails, remove the
        output file.
        * tests/atspecific.m4 (_AT_CHECK_AC_MACRO): Don't check `state-*'
        if the files are not present.

        * m4sugar.m4 (m4_join): Rename as...
        (m4_smash): this.
        * tests/aclocal.m4 (join): Move as...
        * m4sugar.m4 (m4_flatten): this.
        * autoconf.sh (trace.m4): Rename m4_smash as m4_flatten.



To take obvious examples.  I agree it does consume some more space,
but it's really nothing.

~/src/ace % cat =cl-rm-single-title.pl                           nostromo 18:00
#! /usr/bin/perl -w

my $last = '';

while (<>)
  {
    if (/^[0-9]/)
      {
        if ($_ eq $last)
          {
            # Skip this duplicate, and one empty line.
            <>;
            next;
          }
        $last = $_;
      }
    print;
  }
~/src/ace % wc ChangeLog.2                                       nostromo 18:01
  12870   51491  430143 ChangeLog.2
~/src/ace % cl-rm-single-title.pl ChangeLog.2| wc                nostromo 18:01
  11480   48702  399502

I think the augmented readability deserves this 10%.  In the case of
Autoconf, I spent hours reading the ChangeLogs.  They are precious to me.

But I will follow your rules if you want me to <g> :)