Re: [PATCH] Small *.texi{,info} fixes for texinfo 5.0 (PR bootstrap/56258)

[Richard Biener <rguenther at suse dot de>]

On Thu, 21 Feb 2013, Jakub Jelinek wrote:

> Hi!
> 
> Currently it is not possible to bootstrap gcc with texinfo 5.0.
> This patch attempts to fix the errors that prevent bootstrap, there are tons
> of warnings this doesn't address and would be good if somebody more TeXinfo
> knowledgeable looked at it.
> 
> Bootstrapped/regtested on x86_64-linux and i686-linux both with texinfo 5.0
> and older texinfo installed.
> 
> The errors were:
> ../../gcc/doc/invoke.texi:5615: @itemx must follow @item
> ../../gcc/ada/gnat-style.texi:45: unknown command `hfill'
> doc/projects.texi:51: @pxref reference to nonexistent node `Scenarios
>   in Projects'
> doc/projects.texi:363: @pxref reference to nonexistent node `Organizing
>   Projects into Subsystems'
> doc/projects.texi:391: @xref reference to nonexistent node `Project
>   Extension'
> ../../../../../libjava/classpath/doc/cp-tools.texinfo:2030: `@end' expected `smallexample', but saw `table'
> ../../../../../libjava/classpath/doc/cp-tools.texinfo:2030: `@end' expected `smallexample', but saw `table'
> ../../../../../libjava/classpath/doc/cp-tools.texinfo:2030: `@end' expected `smallexample', but saw `table'
> 
> Examples of warnings (many of them occuring many up to several dozens of times):
> warning: @anchor should not appear in @heading
> warning: @title missing argument
> warning: @itemize has text but no @item
> warning: node `XXX' is next for `YYY' in menu but not in sectioning
> warning: node `XXX' is up for `YYY' in menu but not in sectioning
> warning: @itemize has text but no @item
> warning: node next `XXX' in menu `YYY' and in sectioning `ZZZ' differ
> warning: @tex should only appear at a line beginning
> warning: command @tie does not accept arguments
> 
> Ok for trunk?

Ok.  Should we fix the error on branches as well?

Thanks,
Richard.

> 2013-02-21  Jakub Jelinek  <jakub@redhat.com>
> 
> 	PR bootstrap/56258
> 	* doc/invoke.texi (-fdump-rtl-pro_and_epilogue): Use @item
> 	instead of @itemx.
> 
> 	* gnat-style.texi (@title): Remove @hfill.
> 	* projects.texi: Avoid line wrapping inside of @pxref or
> 	@xref.
> 
> 	* doc/cp-tools.texinfo (Virtual Machine Options): Use just
> 	one @gccoptlist instead of 3 separate ones.
> 
> --- gcc/doc/invoke.texi.jj	2013-01-31 22:57:22.000000000 +0100
> +++ gcc/doc/invoke.texi	2013-02-20 13:06:47.516405739 +0100
> @@ -5612,7 +5612,7 @@ Dump after the peephole pass.
>  @opindex fdump-rtl-postreload
>  Dump after post-reload optimizations.
>  
> -@itemx -fdump-rtl-pro_and_epilogue
> +@item -fdump-rtl-pro_and_epilogue
>  @opindex fdump-rtl-pro_and_epilogue
>  Dump after generating the function prologues and epilogues.
>  
> --- gcc/ada/gnat-style.texi.jj	2012-08-10 12:57:33.000000000 +0200
> +++ gcc/ada/gnat-style.texi	2013-02-20 13:06:03.042667300 +0100
> @@ -42,7 +42,7 @@ Texts.  A copy of the license is include
>  @titlepage
>  @titlefont{GNAT Coding Style:}
>  @sp 1
> -@title @hfill A Guide for GNAT Developers
> +@title A Guide for GNAT Developers
>  @subtitle GNAT, The GNU Ada Compiler
>  @versionsubtitle
>  @author Ada Core Technologies, Inc.
> --- gcc/ada/projects.texi.jj	2013-01-04 11:16:24.000000000 +0100
> +++ gcc/ada/projects.texi	2013-02-20 17:48:41.582645159 +0100
> @@ -48,8 +48,7 @@ project files allow you to specify:
>  @item Source file naming conventions; you can specify these either globally or for
>    individual compilation units (@pxref{Naming Schemes}).
>  @item Change any of the above settings depending on external values, thus enabling
> -  the reuse of the projects in various @b{scenarios} (@pxref{Scenarios
> -  in Projects}).
> +  the reuse of the projects in various @b{scenarios} (@pxref{Scenarios in Projects}).
>  @item Automatically build libraries as part of the build process
>    (@pxref{Library Projects}).
>  
> @@ -360,8 +359,8 @@ locating the specified source files in t
>  
>  @item For various reasons, it is sometimes useful to have a project with no
>    sources (most of the time because the attributes defined in the project
> -  file will be reused in other projects, as explained in @pxref{Organizing
> -  Projects into Subsystems}. To do this, the attribute
> +  file will be reused in other projects, as explained in
> +  @pxref{Organizing Projects into Subsystems}. To do this, the attribute
>    @emph{Source_Files} is set to the empty list, i.e. @code{()}. Alternatively,
>    @emph{Source_Dirs} can be set to the empty list, with the same
>    result.
> @@ -388,8 +387,9 @@ locating the specified source files in t
>    This can be done thanks to the attribute @b{Excluded_Source_Files}
>    (or its synonym @b{Locally_Removed_Files}).
>    Its value is the list of file names that should not be taken into account.
> -  This attribute is often used when extending a project, @xref{Project
> -  Extension}. A similar attribute @b{Excluded_Source_List_File} plays the same
> +  This attribute is often used when extending a project,
> +  @xref{Project Extension}. A similar attribute
> +  @b{Excluded_Source_List_File} plays the same
>    role but takes the name of file containing file names similarly to
>    @code{Source_List_File}.
>  
> --- libjava/classpath/doc/cp-tools.texinfo.jj	2012-12-20 11:38:51.000000000 +0100
> +++ libjava/classpath/doc/cp-tools.texinfo	2013-02-20 19:10:42.573925165 +0100
> @@ -2025,7 +2025,7 @@ Doclet, grouped by type.  Explanations a
>  
>  @item Virtual Machine Options
>  @xref{Virtual Machine Options,,Options Controlling Gjdoc Behavior}.
> -@gccoptlist{-classpath}  @gccoptlist{-bootclasspath}  @gccoptlist{-J}@var{vmopt}
> +@gccoptlist{-classpath  -bootclasspath  -J @var{vmopt}}
>  
>  @end table
>  
> 
> 	Jakub
> 
> 

-- 
Richard Biener <rguenther@suse.de>
SUSE / SUSE Labs
SUSE LINUX Products GmbH - Nuernberg - AG Nuernberg - HRB 16746
GF: Jeff Hawn, Jennifer Guild, Felix Imend