This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "GNU M4 source repository".
http://git.sv.gnu.org/gitweb/?p=m4.git;a=commitdiff;h=b881a17fe17d505e7fc5f6f9014ad1da152703d9 The branch, branch-1.6 has been updated via b881a17fe17d505e7fc5f6f9014ad1da152703d9 (commit) from 92f059a8d7e6e6f96e791fcc14d6dcbdba7b3b9c (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit b881a17fe17d505e7fc5f6f9014ad1da152703d9 Author: Eric Blake <[email protected]> Date: Mon Dec 22 09:46:21 2008 -0700 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 <[email protected]> (cherry picked from commit a40a4d17b52d260a6629e2d02052e283a787ad66) ----------------------------------------------------------------------- Summary of changes: ChangeLog | 8 ++++ doc/m4.texinfo | 108 ++++++++++++++++++++++++++++---------------------------- 2 files changed, 62 insertions(+), 54 deletions(-) diff --git a/ChangeLog b/ChangeLog index 895d17a..a0ce716 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,11 @@ +2008-12-22 Eric Blake <[email protected]> + + 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. + 2008-12-18 Eric Blake <[email protected]> Deal with M4 1.4.x limitation on builtin tokens. diff --git a/doc/m4.texinfo b/doc/m4.texinfo index 50d0ace..61da3e6 100644 --- a/doc/m4.texinfo +++ b/doc/m4.texinfo @@ -674,12 +674,12 @@ is also specified. Suppress warnings, such as missing or superfluous arguments in macro calls, or treating the empty string as zero. -...@item --warn-macro-seque...@r{[}=@var{rege...@r{]} -Issue a warning if the regular expression @var{REGEXP} has a non-empty +...@item --warn-macro-seque...@r{[}=@var{rege...@r{]} +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 -...@var{regexp} is not supplied, then the default regular expression is +empty string as @var{regexp} disables any warning. If the optional +...@var{regexp} is not supplied, then the default regular expression is @samp{\$\(@{...@}]*@}\|[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 @@ -688,9 +688,9 @@ handled, @pxref{Arguments}). Providing an alternate regular expression can provide a useful reverse lookup feature of finding where a macro is defined to have a given definition. -...@item -W @var{REGEXP} -...@itemx --word-rege...@var{regexp} -Use @var{REGEXP} as an alternative syntax for macro names. This +...@item -W @var{regexp} +...@itemx --word-rege...@var{regexp} +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 @@ -707,18 +707,18 @@ search path can be altered, and the output file can track where the input came from. These features occur with the following options: @table @code -...@item -D @var{na...@r{[}=@var{val...@r{]} -...@itemx --defi...@var{name}@r{...@var{value}@r{]} -This enters @var{NAME} into the symbol table. If @sam...@var{value}} is -missing, the value is taken to be the empty string. The @var{VALUE} can +...@item -D @var{na...@r{[}=@var{val...@r{]} +...@itemx --defi...@var{name}@r{...@var{value}@r{]} +This enters @var{name} into the symbol table. If @sam...@var{value}} 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. -...@item -I @var{DIRECTORY} -...@itemx --inclu...@var{directory} -Make @code{m4} search @var{DIRECTORY} for included files that are not +...@item -I @var{directory} +...@itemx --inclu...@var{directory} +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. @@ -778,11 +778,11 @@ goodbye @result{}goodbye @end example -...@item -U @var{NAME} -...@itemx --undefi...@var{name} -This deletes any predefined meaning @var{NAME} might have. Obviously, +...@item -U @var{name} +...@itemx --undefi...@var{name} +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 @@ -819,18 +819,18 @@ environment. Suppress all the extensions made in this implementation, compared to the System V version. @xref{Compatibility}, for a list of these. -...@item -H @var{NUM} -...@itemx --hashsi...@var{num} -Make the internal hash table for symbol lookup be @var{NUM} entries big. +...@item -H @var{num} +...@itemx --hashsi...@var{num} +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. -...@item -L @var{NUM} -...@itemx --nesting-lim...@var{num} +...@item -L @var{num} +...@itemx --nesting-lim...@var{num} @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 is limited to 1024 levels. A value of zero means unlimited; but then heavily nested code could potentially cause a stack @@ -854,9 +854,9 @@ only the simplest example (but @pxref{Compatibility}). Expecting @acronym{GNU} system to detect and diagnose endless loops: it is a quite @emph{hard} problem in general, if not undecidable! -...@item -B @var{NUM} -...@itemx -S @var{NUM} -...@itemx -T @var{NUM} +...@item -B @var{num} +...@itemx -S @var{num} +...@itemx -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. @@ -870,16 +870,16 @@ releases, and issue a warning to that effect. execution when reusing a common initialization script. @table @code -...@item -F @var{FILE} -...@itemx --freeze-sta...@var{file} +...@item -F @var{file} +...@itemx --freeze-sta...@var{file} Once execution is finished, write out the frozen state on the specified -...@var{file}. It is conventional, but not required, for @var{FILE} to end +...@var{file}. It is conventional, but not required, for @var{file} to end in @samp{.m4f}. -...@item -R @var{FILE} -...@itemx --reload-sta...@var{file} +...@item -R @var{file} +...@itemx --reload-sta...@var{file} 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 @@ -891,18 +891,18 @@ Finally, there are several options for aiding in debugging @code{m4} scripts. @table @code -...@item -...@r{[}@r{...@r{|}...@r{]}@var{fla...@r{]} -...@itemx --de...@r{[}=@r{...@r{|}...@r{]}@var{fla...@r{]} -...@itemx --debugm...@r{[}=@r{...@r{|}...@r{]}@var{fla...@r{]} -Set the debug-level according to the flags @var{FLAGS}. The debug-level +...@item -...@r{[}@r{...@r{|}...@r{]}@var{fla...@r{]} +...@itemx --de...@r{[}=@r{...@r{|}...@r{]}@var{fla...@r{]} +...@itemx --debugm...@r{[}=@r{...@r{|}...@r{]}@var{fla...@r{]} +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{Debugmode}, for more details on the format and -meaning of @var{FLAGS}. If omitted, @var{FLAGS} defaults to -...@samp{+adeq}. If the option occurs multiple times, @var{FLAGS} starting -with @samp{-} or @samp{+} are cumulative, while @var{FLAGS} starting +meaning of @var{flags}. If omitted, @var{flags} defaults to +...@samp{+adeq}. If the option occurs multiple times, @var{flags} starting +with @samp{-} or @samp{+} are cumulative, while @var{flags} starting with a letter override all earlier settings. The debug-level starts with @samp{d} enabled and all other flags disabled. To disable all -previously set flags, specify an explicit @var{FLAGS} of @samp{-V}. For +previously set flags, specify an explicit @var{flags} of @samp{-V}. For backward compatibility reasons, the option @option{--fatal-warnings} implies @samp{--debug=-d} as part of its effects. The spelling @option{--debug} is recognized as an unambiguous option for @@ -923,11 +923,11 @@ len(`123') @result{}3 @end example -...@item --debugfi...@var{file} -...@itemx -o @var{FILE} -...@itemx --error-outp...@var{file} +...@item --debugfi...@var{file} +...@itemx -o @var{file} +...@itemx --error-outp...@var{file} 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 unspecified, debug output goes to standard error; if empty, debug output is discarded. @xref{Debugfile}, for more details. The spellings @option{-o} and @@ -936,16 +936,16 @@ to standard error; if empty, debug output is discarded. @option{--debugfile}, but in a future version of M4, using them will cause a warning to be issued. -...@item -l @var{NUM} -...@itemx --argleng...@var{num} -Restrict the size of the output generated by macro tracing to @var{NUM} +...@item -l @var{num} +...@itemx --argleng...@var{num} +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{Debugmode}, for more details. -...@item -t @var{NAME} -...@itemx --tra...@var{name} -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. +...@item -t @var{name} +...@itemx --tra...@var{name} +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 @@ -8767,7 +8767,7 @@ builtin tokens through a macro call. It is likewise possible to 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 -...@var{_stack_reverse_sep}, implemented by prepending the original +...@code{_stack_reverse_sep}, 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 hooks/post-receive -- GNU M4 source repository
