mirror/autoconf
2
0
Fork 0
mirror of git://git.sv.gnu.org/autoconf synced 2024-12-03 02:00:36 +08:00
Code Issues Packages Projects Releases Wiki Activity

doc: fix texinfo macro usage

Browse Source 
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
This commit is contained in:
Patrice Dumas 2012-07-18 13:41:45 -06:00 committed by Eric Blake
parent 8c8522f1c5
commit a357718b08
2 changed files with 13 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
THANKS
View File

@ -316,6 +316,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

24
doc/autoconf.texi
View File

@ -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.
@ -8014,10 +8014,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}
@ -8268,8 +8268,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
@ -8287,8 +8287,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
@ -8314,8 +8314,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