[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH] doc: fix style issues in the display of macro optional arguments
From: |
Akim Demaille |
Subject: |
[PATCH] doc: fix style issues in the display of macro optional arguments |
Date: |
Sun, 22 Jul 2012 11:49:49 +0200 |
-8<-
Hi all,
I was reading at the documentation of m4_map_args_pair, which reads as
follows:
-- Macro: m4_map_args_pair (MACRO, [MACRO-END = `macro'], ARG...)
For every pair of arguments ARG, invoke MACRO with two arguments.
If there is an odd number of arguments, invoke MACRO-END, which
defaults to MACRO, with the remaining argument.
The way the default value of MACRO-END is display is wrong.
-8<-
* doc/autoconf.texi (@dvarv): New.
Use it where optional macro arguments default to other arguments.
---
doc/autoconf.texi | 18 +++++++++++++-----
1 file changed, 13 insertions(+), 5 deletions(-)
diff --git a/doc/autoconf.texi b/doc/autoconf.texi
index 927921c..b542c8e 100644
--- a/doc/autoconf.texi
+++ b/doc/autoconf.texi
@@ -26,6 +26,14 @@
@address@hidden = @address@hidden
@end macro
address@hidden @dvarv(ARG, DEFAULT-VAR)
address@hidden ------------------------
address@hidden Same as @dvar{ARG, @var{DEFAULT-VAR}}, but with the superfluous
address@hidden @samp around DEFAULT-VAR.
address@hidden dvarv{varname, default}
address@hidden@var{\varname\} = @address@hidden@c
address@hidden macro
+
@c Handling the indexes with Texinfo yields several different problems.
@c
@c Because we want to drop out the AC_ part of the macro names in the
@@ -12436,7 +12444,7 @@ list_add_x([1], list)
@end example
@end defmac
address@hidden m4_map_args_pair (@var{macro}, @dvar{macro-end, macro}, @
address@hidden m4_map_args_pair (@var{macro}, @dvarv{macro-end, macro}, @
@address@hidden)
@msindex{map_args_pair}
For every pair of arguments @var{arg}, invoke @var{macro} with two
@@ -13016,7 +13024,7 @@ quadrigraphs can be used to work around this.
@end defmac
@defmac m4_text_wrap (@var{string}, @ovar{prefix}, @
- @dvar{prefix1, @var{prefix}}, @dvar{width, 79})
+ @dvarv{prefix1, prefix}, @dvar{width, 79})
@msindex{text_wrap}
Break @var{string} into a series of whitespace-separated words, then
output those words separated by spaces, and wrapping lines any time the
@@ -13795,9 +13803,9 @@ undefined if expansion of an indirect variable does not
result in a
literal variable name.
@defmac AS_LITERAL_IF (@var{expression}, @ovar{if-literal}, @ovar{if-not}, @
- @dvar{if-simple-ref, @var{if-not}})
+ @dvarv{if-simple-ref, if-not})
@defmacx AS_LITERAL_WORD_IF (@var{expression}, @ovar{if-literal}, @
- @ovar{if-not}, @dvar{if-simple-ref, @var{if-not}})
+ @ovar{if-not}, @dvarv{if-simple-ref, if-not})
@asindex{LITERAL_IF}
@asindex{LITERAL_WORD_IF}
If the expansion of @var{expression} is definitely a shell literal,
@@ -25473,7 +25481,7 @@ hierarchy: the test suite ought to be shipped! See
below for an example.
@item
Invoke @code{AC_CONFIG_TESTDIR} in your @file{configure.ac}.
address@hidden AC_CONFIG_TESTDIR (@var{directory}, @dvar{test-path, directory})
address@hidden AC_CONFIG_TESTDIR (@var{directory}, @dvarv{test-path, directory})
@acindex{CONFIG_TESTDIR}
An Autotest test suite is to be configured in @var{directory}. This
macro causes @address@hidden/atconfig} to be created by
--
1.7.11.2
- [PATCH] doc: fix style issues in the display of macro optional arguments,
Akim Demaille <=