Re: CVS Texinfo fails to build the Autoconf manual (from git)

[Eric Blake]

On 07/18/2012 12:24 PM, Patrice Dumas wrote:
> 
>      On the other hand, you wouldn't want the '@c' if the macro was
>      sometimes invoked in the middle of a line (the text after the
>      invocation would be treated as a comment).
> 
> 
> As the macro invocation is on a line, in the example of the autoconf
> manual, it should (in my opinion) be covered by the very last paragraph,
> although I guess the autoconf manual writers may disagree with me.

No, that actually makes it sound like removing the @c from the macro
definition is the right thing to do - it should produce the same output
with both the old and new conversions, if the documentation is to be
believed.

> 
> As a side note, there is also another item, still in limitations 
> of @macros in TeX that says
> 
>    * Macro arguments cannot cross lines.

Is that restriction limited to a per-argument basis (but you can have
newlines between arguments), or is it global to the entire macro call?
At any rate, I'd rather err on the side of caution, and fix this
questionable usage in autoconf.

> 
> which means that the autoconf macro invocation should not be valid in TeX,
> because of the @ followed by a newline that leads to the second argument
> being on the next line.

If the latter, the solution in autoconf.texi would be to split the line
before the @dvar, not in the middle of @dvar argument collection.

Does this patch look appropriate for autoconf?  I got no complaints with
my older setup, and the resulting .info file still looked reasonable to
me.  [I also note that other packages have copied from autoconf; at
least GNU m4 will be similarly afflicted, and need a similar scrubbing]

diff --git i/doc/autoconf.texi w/doc/autoconf.texi
index 78a2c67..506d966 100644
--- i/doc/autoconf.texi
+++ w/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}
address@hidden@address@hidden@c
address@hidden@address@hidden
 @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}
address@hidden@var{\varname\} = @address@hidden@c
address@hidden@var{\varname\} = @address@hidden
 @end macro

 @c Handling the indexes with Texinfo yields several different problems.
@@ -8014,10 +8014,10 @@ Fortran Compiler
 @code{ac_cv_f77_libs} or @code{ac_cv_fc_libs}, respectively.
 @end defmac

address@hidden AC_F77_DUMMY_MAIN (@ovar{action-if-found},
@dvar{action-if-not-found, @
-  AC_MSG_FAILURE})
address@hidden AC_FC_DUMMY_MAIN (@ovar{action-if-found},
@dvar{action-if-not-found, @
-  AC_MSG_FAILURE})
address@hidden AC_F77_DUMMY_MAIN (@ovar{action-if-found}, @
+  @dvar{action-if-not-found, AC_MSG_FAILURE})
address@hidden 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 @@ Fortran Compiler
 @address@hidden variables, respectively.
 @end defmac

address@hidden AC_FC_PP_DEFINE (@ovar{action-if-success},
@dvar{action-if-failure, @
-  AC_MSG_FAILURE})
address@hidden 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 @@ Fortran Compiler
 variable.
 @end defmac

address@hidden AC_FC_FREEFORM (@ovar{action-if-success},
@dvar{action-if-failure, @
-  AC_MSG_FAILURE})
address@hidden AC_FC_FREEFORM (@ovar{action-if-success}, @
+  @dvar{action-if-failure, AC_MSG_FAILURE})
 @acindex{FC_FREEFORM}
 @caindex fc_freeform

@@ -8314,8 +8314,8 @@ Fortran Compiler
 the @code{ac_cv_fc_freeform} variable.
 @end defmac

address@hidden AC_FC_FIXEDFORM (@ovar{action-if-success},
@dvar{action-if-failure, @
-  AC_MSG_FAILURE})
address@hidden AC_FC_FIXEDFORM (@ovar{action-if-success}, @
+  @dvar{action-if-failure, AC_MSG_FAILURE})
 @acindex{FC_FIXEDFORM}
 @caindex fc_fixedform

-- 
Eric Blake   address@hidden    +1-919-301-3266
Libvirt virtualization library http://libvirt.org

signature.asc
Description: OpenPGP digital signature