@var usage

[Eric Blake]

texinfo automatically capitalizes the contents of @var{...}, and recommends 
using @var{a-b} over @var{a_b} when multi-word meta-syntactic names are needed 
(m4 didn't use any multi-word names, but searching for @var{[^}]_ found a bug 
in using @var incorrectly on a non-meta-syntactic name).  This cleans up the 
branch-1.4 manual; I'm applying similar patches on the other branches.


From: Eric Blake <address@hidden>
Date: Mon, 22 Dec 2008 08:51:00 -0700
Subject: [PATCH] Use @var correctly.

* doc/m4.texinfo (Operation modes, Preprocessor features)
(Limits control, Frozen state, Debugging options): Use lower case
names in @var.
(Improved copy): Use @code, not @var, as appropriate.

Signed-off-by: Eric Blake <address@hidden>
---
 ChangeLog      |    6 +++
 doc/m4.texinfo |  108 ++++++++++++++++++++++++++++----------------------------
 2 files changed, 60 insertions(+), 54 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index b094064..392058a 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,11 @@
 2008-12-22  Eric Blake  <address@hidden>
 
+       Use @var correctly.
+       * doc/m4.texinfo (Operation modes, Preprocessor features)
+       (Limits control, Frozen state, Debugging options): Use lower case
+       names in @var.
+       (Improved copy): Use @code, not @var, as appropriate.
+
        Make --debugfile argument optional.
        * src/builtin.c (m4_debugfile): Make error message consistent.
        * src/m4.c (long_options): Make the argument optional, to allow
diff --git a/doc/m4.texinfo b/doc/m4.texinfo
index a76df90..de4710a 100644
--- a/doc/m4.texinfo
+++ b/doc/m4.texinfo
@@ -620,12 +620,12 @@ Operation modes
 Suppress warnings, such as missing or superfluous arguments in macro
 calls, or treating the empty string as zero.
 
address@hidden address@hidden@address@hidden
-Issue a warning if the regular expression @var{REGEXP} has a non-empty
address@hidden address@hidden@address@hidden
+Issue a warning if the regular expression @var{regexp} has a non-empty
 match in any macro definition (either by @code{define} or
 @code{pushdef}).  Empty matches are ignored; therefore, supplying the
-empty string as @var{REGEXP} disables any warning.  If the optional
address@hidden is not supplied, then the default regular expression is
+empty string as @var{regexp} disables any warning.  If the optional
address@hidden is not supplied, then the default regular expression is
 @samp{\$\(@address@hidden@}\|[0-9][0-9]+\)} (a literal @samp{$} followed by
 multiple digits or by an open brace), since these sequences will
 change semantics in the default operation of @acronym{GNU} M4 2.0 (due
@@ -634,9 +634,9 @@ Operation modes
 expression can provide a useful reverse lookup feature of finding
 where a macro is defined to have a given definition.
 
address@hidden -W @var{REGEXP}
address@hidden address@hidden
-Use @var{REGEXP} as an alternative syntax for macro names.  This
address@hidden -W @var{regexp}
address@hidden address@hidden
+Use @var{regexp} as an alternative syntax for macro names.  This
 experimental option will not be present in all @acronym{GNU} @code{m4}
 implementations (@pxref{Changeword}).
 @end table
@@ -653,18 +653,18 @@ Preprocessor features
 input came from.  These features occur with the following options:
 
 @table @code
address@hidden -D @address@hidden@address@hidden
address@hidden address@hidden@address@hidden@r{]}
-This enters @var{NAME} into the symbol table.  If @address@hidden is
-missing, the value is taken to be the empty string.  The @var{VALUE} can
address@hidden -D @address@hidden@address@hidden
address@hidden address@hidden@address@hidden@r{]}
+This enters @var{name} into the symbol table.  If @address@hidden is
+missing, the value is taken to be the empty string.  The @var{value} can
 be any string, and the macro can be defined to take arguments, just as
 if it was defined from within the input.  This option may be given more
 than once; order with respect to file names is significant, and
-redefining the same @var{NAME} loses the previous value.
+redefining the same @var{name} loses the previous value.
 
address@hidden -I @var{DIRECTORY}
address@hidden address@hidden
-Make @code{m4} search @var{DIRECTORY} for included files that are not
address@hidden -I @var{directory}
address@hidden address@hidden
+Make @code{m4} search @var{directory} for included files that are not
 found in the current working directory.  @xref{Search Path}, for more
 details.  This option may be given more than once.
 
@@ -724,11 +724,11 @@ Preprocessor features
 @result{}goodbye
 @end example
 
address@hidden -U @var{NAME}
address@hidden address@hidden
-This deletes any predefined meaning @var{NAME} might have.  Obviously,
address@hidden -U @var{name}
address@hidden address@hidden
+This deletes any predefined meaning @var{name} might have.  Obviously,
 only predefined macros can be deleted in this way.  This option may be
-given more than once; undefining a @var{NAME} that does not have a
+given more than once; undefining a @var{name} that does not have a
 definition is silently ignored.  Order is significant with respect to
 file names.
 @end table
@@ -765,18 +765,18 @@ Limits control
 Suppress all the extensions made in this implementation, compared to the
 System V version.  @xref{Compatibility}, for a list of these.
 
address@hidden -H @var{NUM}
address@hidden address@hidden
-Make the internal hash table for symbol lookup be @var{NUM} entries big.
address@hidden -H @var{num}
address@hidden address@hidden
+Make the internal hash table for symbol lookup be @var{num} entries big.
 For better performance, the number should be prime, but this is not
 checked.  The default is 509 entries.  It should not be necessary to
 increase this value, unless you define an excessive number of macros.
 
address@hidden -L @var{NUM}
address@hidden address@hidden
address@hidden -L @var{num}
address@hidden address@hidden
 @cindex nesting limit
 @cindex limit, nesting
-Artificially limit the nesting of macro calls to @var{NUM} levels,
+Artificially limit the nesting of macro calls to @var{num} levels,
 stopping program execution if this limit is ever exceeded.  When not
 specified, nesting defaults to unlimited on platforms that can detect
 stack overflow, and to 1024 levels otherwise.  A value of zero means
@@ -801,15 +801,15 @@ Limits control
 system to detect and diagnose endless loops: it is a quite @emph{hard}
 problem in general, if not undecidable!
 
address@hidden -B @var{NUM}
address@hidden -S @var{NUM}
address@hidden -T @var{NUM}
address@hidden -B @var{num}
address@hidden -S @var{num}
address@hidden -T @var{num}
 These options are present for compatibility with System V @code{m4}, but
 do nothing in this implementation.  They may disappear in future
 releases, and issue a warning to that effect.
 
address@hidden -N @var{NUM}
address@hidden address@hidden
address@hidden -N @var{num}
address@hidden address@hidden
 These options are present only for compatibility with previous
 versions of @acronym{GNU} @code{m4}, and were controlling the number of
 possible diversions which could be used at the same time.  They do nothing,
@@ -825,16 +825,16 @@ Frozen state
 execution when reusing a common initialization script.
 
 @table @code
address@hidden -F @var{FILE}
address@hidden address@hidden
address@hidden -F @var{file}
address@hidden address@hidden
 Once execution is finished, write out the frozen state on the specified
address@hidden  It is conventional, but not required, for @var{FILE} to end
address@hidden  It is conventional, but not required, for @var{file} to end
 in @samp{.m4f}.
 
address@hidden -R @var{FILE}
address@hidden address@hidden
address@hidden -R @var{file}
address@hidden address@hidden
 Before execution starts, recover the internal state from the specified
-frozen @var{FILE}.  The options @option{-D}, @option{-U}, and
+frozen @var{file}.  The options @option{-D}, @option{-U}, and
 @option{-t} take effect after state is reloaded, but before the input
 files are read.
 @end table
@@ -846,21 +846,21 @@ Debugging options
 scripts.
 
 @table @code
address@hidden address@hidden@address@hidden
address@hidden address@hidden@address@hidden
-Set the debug-level according to the flags @var{FLAGS}.  The debug-level
address@hidden address@hidden@address@hidden
address@hidden address@hidden@address@hidden
+Set the debug-level according to the flags @var{flags}.  The debug-level
 controls the format and amount of information presented by the debugging
 functions.  @xref{Debug Levels}, for more details on the format and
-meaning of @var{FLAGS}.  If omitted, @var{FLAGS} defaults to @samp{aeq}.
+meaning of @var{flags}.  If omitted, @var{flags} defaults to @samp{aeq}.
 
address@hidden address@hidden@address@hidden
address@hidden -o @var{FILE}
address@hidden address@hidden
address@hidden address@hidden@address@hidden
address@hidden -o @var{file}
address@hidden address@hidden
 Redirect @code{dumpdef} output, debug messages, and trace output to the
-named @var{FILE}.  Warnings, error messages, and @code{errprint} output
+named @var{file}.  Warnings, error messages, and @code{errprint} output
 are still printed to standard error.  If these options are not used, or
-if @var{FILE} is unspecified (only possible for @option{--debugfile}),
-debug output goes to standard error; if @var{FILE} is the empty string,
+if @var{file} is unspecified (only possible for @option{--debugfile}),
+debug output goes to standard error; if @var{file} is the empty string,
 debug output is discarded.  @xref{Debug Output}, for more details.  The
 option @option{--debugfile} may be given more than once, and order is
 significant with respect to file names.  The spellings @option{-o} and
@@ -886,16 +886,16 @@ Debugging options
 @end example
 @end ignore
 
address@hidden -l @var{NUM}
address@hidden address@hidden
-Restrict the size of the output generated by macro tracing to @var{NUM}
address@hidden -l @var{num}
address@hidden address@hidden
+Restrict the size of the output generated by macro tracing to @var{num}
 characters per trace line.  If unspecified or zero, output is
 unlimited.  @xref{Debug Levels}, for more details.
 
address@hidden -t @var{NAME}
address@hidden address@hidden
-This enables tracing for the macro @var{NAME}, at any point where it is
-defined.  @var{NAME} need not be defined when this option is given.
address@hidden -t @var{name}
address@hidden address@hidden
+This enables tracing for the macro @var{name}, at any point where it is
+defined.  @var{name} need not be defined when this option is given.
 This option may be given more than once, and order is significant with
 respect to file names.  @xref{Trace}, for more details.
 @end table
@@ -8200,7 +8200,7 @@ Improved copy
 directly reference the stack definitions without a macro call, by
 leaving @var{pre} and @var{post} empty.  The new macro also adds a
 separator that is only output after the first iteration of the helper
address@hidden, implemented by prepending the original
address@hidden, implemented by prepending the original
 @var{sep} to @var{pre} and omitting a @var{sep} argument in subsequent
 iterations.  As an added bonus, using @code{stack_foreach_sep} to
 implement @code{copy} performs fewer macro invocations.  The improved
-- 
1.6.0.4