diff options
| author | Patrice Dumas <pertusus@free.fr> | 2012-07-18 13:41:45 -0600 |
|---|---|---|
| committer | Javier Jardón <jjardon@gnome.org> | 2015-06-11 11:41:13 +0100 |
| commit | 218f9347c9c34919c2b8eef8d9a0513ac567a3c1 (patch) | |
| tree | 05f74f18126892fcb3930de87feabe36dcba53f0 | |
| parent | 771017a4336bcc38b99c84e345c94a8910b89996 (diff) | |
| download | autoconf-218f9347c9c34919c2b8eef8d9a0513ac567a3c1.tar.gz | |
doc: fix texinfo macro usagebaserock/v2.69-texinfo-fix
The texinfo manual recommends avoiding the use of a trailing @c in
any macro designed to be used inline (as is the case with our ovar
and dvar macros). Furthermore, passing '@\n' in the middle of a
macro call is much different than passing '@\n' between arguments
of a @defmac for line continuation.
* doc/autoconf.texi (ovar, dvar): Don't end macro with @c, since
these macros are designed to be embedded in one-line usage.
(Fortran Compiler): Don't split @dvar.
* THANKS: Update.
Reported by Stefano Lattarini.
Signed-off-by: Eric Blake <eblake@redhat.com>
Copyright-paperwork-exempt: Yes
| -rw-r--r-- | THANKS | 1 | ||||
| -rw-r--r-- | doc/autoconf.texi | 24 |
2 files changed, 13 insertions, 12 deletions
@@ -315,6 +315,7 @@ Olly Betts olly@survex.com Ossama Othman ossama@debian.org Pallav Gupta pallavgupta@gmail.com Paolo Bonzini bonzini@gnu.org +Patrice Dumas pertusus@free.fr Patrick Tullmann tullmann@cs.utah.edu Patrick Welche prlw1@newn.cam.ac.uk Paul Berrevoets paul@swi.com diff --git a/doc/autoconf.texi b/doc/autoconf.texi index 34ca2137..38731143 100644 --- a/doc/autoconf.texi +++ b/doc/autoconf.texi @@ -15,7 +15,7 @@ @c The ARG is an optional argument. To be used for macro arguments in @c their documentation (@defmac). @macro ovar{varname} -@r{[}@var{\varname\}@r{]}@c +@r{[}@var{\varname\}@r{]} @end macro @c @dvar(ARG, DEFAULT) @@ -23,7 +23,7 @@ @c The ARG is an optional argument, defaulting to DEFAULT. To be used @c for macro arguments in their documentation (@defmac). @macro dvar{varname, default} -@r{[}@var{\varname\} = @samp{\default\}@r{]}@c +@r{[}@var{\varname\} = @samp{\default\}@r{]} @end macro @c Handling the indexes with Texinfo yields several different problems. @@ -8013,10 +8013,10 @@ variables, respectively. The computed linker flags are cached in @code{ac_cv_f77_libs} or @code{ac_cv_fc_libs}, respectively. @end defmac -@defmac AC_F77_DUMMY_MAIN (@ovar{action-if-found}, @dvar{action-if-not-found, @ - AC_MSG_FAILURE}) -@defmacx AC_FC_DUMMY_MAIN (@ovar{action-if-found}, @dvar{action-if-not-found, @ - AC_MSG_FAILURE}) +@defmac AC_F77_DUMMY_MAIN (@ovar{action-if-found}, @ + @dvar{action-if-not-found, AC_MSG_FAILURE}) +@defmacx AC_FC_DUMMY_MAIN (@ovar{action-if-found}, @ + @dvar{action-if-not-found, AC_MSG_FAILURE}) @acindex{F77_DUMMY_MAIN} @cvindex F77_DUMMY_MAIN @acindex{FC_DUMMY_MAIN} @@ -8267,8 +8267,8 @@ results in @code{ac_cv_fc_srcext_@var{ext}} and @code{ac_cv_fc_pp_srcext_@var{ext}} variables, respectively. @end defmac -@defmac AC_FC_PP_DEFINE (@ovar{action-if-success}, @dvar{action-if-failure, @ - AC_MSG_FAILURE}) +@defmac AC_FC_PP_DEFINE (@ovar{action-if-success}, @ + @dvar{action-if-failure, AC_MSG_FAILURE}) @acindex{FC_PP_DEFINE} @caindex fc_pp_define @@ -8286,8 +8286,8 @@ The result of this test is cached in the @code{ac_cv_fc_pp_define} variable. @end defmac -@defmac AC_FC_FREEFORM (@ovar{action-if-success}, @dvar{action-if-failure, @ - AC_MSG_FAILURE}) +@defmac AC_FC_FREEFORM (@ovar{action-if-success}, @ + @dvar{action-if-failure, AC_MSG_FAILURE}) @acindex{FC_FREEFORM} @caindex fc_freeform @@ -8313,8 +8313,8 @@ The result of this test, or @samp{none} or @samp{unknown}, is cached in the @code{ac_cv_fc_freeform} variable. @end defmac -@defmac AC_FC_FIXEDFORM (@ovar{action-if-success}, @dvar{action-if-failure, @ - AC_MSG_FAILURE}) +@defmac AC_FC_FIXEDFORM (@ovar{action-if-success}, @ + @dvar{action-if-failure, AC_MSG_FAILURE}) @acindex{FC_FIXEDFORM} @caindex fc_fixedform |