[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

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

From: Eric Blake
Subject: Re: [PATCH 2/2] doc: index entries for non-environment, non-output variables.
Date: Tue, 07 Sep 2010 08:35:09 -0600
User-agent: Mozilla/5.0 (X11; U; Linux x86_64; en-US; rv: Gecko/20100827 Red Hat/3.1.3-1.el6 Mnenhy/0.8.3 Thunderbird/3.1.3

On 09/06/2010 12:07 AM, Ralf Wildenhues wrote:
* doc/autoconf.texi: Merge variable index `vr' into concept
index using syncodeindex.
* doc/autoconf.texi (Configuration Actions, Generic Programs)
(Generic Functions, Initialization Macros, Writing Testsuites):
Add index entries for documented shell variables used during
in configure and testsuite scripts.  Fix entry for `tmp'.

  @table @code
  @item srcdir
address@hidden srcdir

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.

  @item tmp
address@hidden tmp
  The name of a temporary directory within the build tree, which you
  can use if you need to create additional temporary files.  The
  directory is cleaned up when @command{config.status} is done or

In fact, I just added @ovindex tmp to AS_TMPDIR recently.

@@ -4316,7 +4324,7 @@ Generic Programs
    @ovar{action-if-not-found}, @dvar{path, $PATH})
  @caindex address@hidden
address@hidden address@hidden
address@hidden address@hidden

This hunk may conflict with the resolution for the issue raised resolution on your previous patch.

@@ -13706,7 +13715,7 @@ Initialization Macros
  @defmac AS_TMPDIR (@var{prefix}, @dvar{dir, address@hidden:=/address@hidden)
  @evindex TMPDIR
address@hidden tmp
address@hidden tmp
  Create, as safely as possible, a temporary sub-directory within
  @var{dir} with a name starting with @var{prefix}.  @var{prefix} should
  be 2-4 characters, to make it slightly easier to identify the owner of

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?

I think we'll need another attempt at this patch before pushing anything.

Eric Blake   address@hidden    +1-801-349-2682
Libvirt virtualization library

reply via email to

[Prev in Thread] Current Thread [Next in Thread]