Re: [PATCH 2/2] doc: index entries for non-environment, non-output variables.

[Eric Blake]

On 09/12/2010 01:44 AM, Ralf Wildenhues wrote:
> > Why @vrindex instead of @ovindex?  We already document:
> >
> > @c Define an output variable index.
> > @defcodeindex ov
> >
> > for all variables that are set during configure/autotest for use by
> > the remainder of the script.
> [...]
>
> > Oh, I see - you're trying to make a distinction between @ovindex and
> > @vrindex.  Can we document that distinction both in the commit
> > message and in the comments at the top of autoconf.texi that
> > describe all the various indices?
>
> Sure.  Here's a redo of the remainder of 1/2 and fixed 2/2, with
> comments for the various indices updated.  OK?

Yeah, the comments are key; and with those, the rest of the patch makes 
total sense.  Okay to apply!

>      doc: index entries for non-environment, non-output variables.
>
>      * doc/autoconf.texi: Clarify the meaning of the various variable
>      indices.  Merge variable index `vr' into concept index using
>      syncodeindex.
>      (Configuration Actions, Generic Programs, Generic Functions)
>      (Writing Testsuites): Add index entries for documented shell
>      variables used during in configure and testsuite scripts.

--
Eric Blake   address@hidden    +1-801-349-2682
Libvirt virtualization library http://libvirt.org