Re: [PATCH] documentation errors

[Ralf Wildenhues]

Hello William,

* William Pursell wrote on Sun, Nov 23, 2008 at 06:18:47PM CET:
> here's another set of corrections to the documentation.

Thanks.

> There was a question I had that I notated by adding
> comments to the .texi file which appears in the patch
> below re: AM_PROG_CC_C_O.  The documentation claims
> that one must invoke AM_PROG_CC_C_O in order to use
> program_CFLAGS, but I have succesfully used program_CFLAGS
> and have never used AM_PROG_CC_C_O, so I believe
> this is out of date.

Do you use 'automake -Wall'?  The warning about AM_PROG_CC_C_O has
been demoted a while ago IIRC.

BTW, your patches are good, but you can make my life even easier
by not mixing two independent things (corrections, and annotations)
in one patch.  These things are orthogonal, so should be in separate
changes; of course, such an annotation should not be in the tree at
all unless we cannot fix it.

Also, but this is really rather nitpicky and not required at all,
I prefer receiving patches with the ChangeLog entry being part of
the git commit log message, and the patch not touching the ChangeLog
file at all.  That way, the patch can easily be committed even if it
was written against an older tree.

> --- a/ChangeLog
> +++ b/ChangeLog
> @@ -1,3 +1,16 @@
> +
> +2008-11-23  William Pursell  <address@hidden>
> +
> +     * doc/automake.texi (Macro search path, Extending aclocal)
> +     (Local Macros, Serials, Public macros, Directories)
> +     (Conditional Subdirectories, Nesting Packages)
> +     (Building a program, Libtool Modules)
> +     (Program and Library Variables, Default _SOURCES, LIBOBJS):
> +     Mostly correcting verb/object tense agreement  (ie:
> +     "Here is a case that illustrate" s/illustrate/illustrates/),
> +     some word swaps ("need just" becomes "just need"), and
> +     general trivial cleanup.

Your attention to detail seems much more focused in the manual than when
writing the ChangeLog.  :-)
I deleted the first line, and rewrote the text as below, and pushed to
master and branch-1-10.

Cheers,
Ralf

2008-11-23  William Pursell  <address@hidden>

        * doc/automake.texi (Macro search path, Extending aclocal)
        (Local Macros, Serials, Public macros, Directories)
        (Conditional Subdirectories, Nesting Packages)
        (Building a program, Libtool Modules)
        (Program and Library Variables, Default _SOURCES, LIBOBJS):
        Correct verb/object tense agreement, swap some words,
        and general trivial cleanup.