PATCH: [doc] fix texinfo markup errors

PATCH: [doc] fix texinfo markup errors

[Sandra Loosemore]

[-- Attachment #1: Type: text/plain, Size: 809 bytes --]

This patch fixes some invalid texinfo markup in the GCC manuals that I found 
while experimenting with makeinfo --docbook.  I also fixed some @ref/@xref 
confusion I noted nearby.  OK to apply?  I'm not sure if this sort of thing 
qualifies as "obvious" or not....  better to be safe and ask first.  :-)

-Sandra

2008-06-23  Sandra Loosemore  <sandra@codesourcery.com>

	gcc/
	* doc/extend.texi (Variable Attributes): Use @ref instead of @xref.
	(Type Attributes): Fix nesting of @table and @subsection.  Adjust
	punctuation.  Use @ref instead of @xref.
	(Function Names): Remove stray @display/@end display.
	(C++ Attributes): Use @ref instead of @xref.
	(Deprecated Features): Fix punctuation around @xref.
	(Backwards Compatibility): Likewise.
	* doc/rtl.texi (Incdec): Remove stray @table/@end table.




[-- Attachment #2: gcc.patch --]
[-- Type: text/x-patch, Size: 7822 bytes --]

Index: gcc/doc/extend.texi
===================================================================
*** gcc/doc/extend.texi	(revision 137047)
--- gcc/doc/extend.texi	(working copy)
*************** targets.  You can use @code{__declspec (
*** 3768,3780 ****
  compilers.
  
  @item weak
! The @code{weak} attribute is described in @xref{Function Attributes}.
  
  @item dllimport
! The @code{dllimport} attribute is described in @xref{Function Attributes}.
  
  @item dllexport
! The @code{dllexport} attribute is described in @xref{Function Attributes}.
  
  @end table
  
--- 3768,3780 ----
  compilers.
  
  @item weak
! The @code{weak} attribute is described in @ref{Function Attributes}.
  
  @item dllimport
! The @code{dllimport} attribute is described in @ref{Function Attributes}.
  
  @item dllexport
! The @code{dllexport} attribute is described in @ref{Function Attributes}.
  
  @end table
  
*************** Three attributes currently are defined f
*** 3955,3975 ****
  @code{altivec}, @code{ms_struct} and @code{gcc_struct}.
  
  For full documentation of the struct attributes please see the
! documentation in the @xref{i386 Variable Attributes}, section.
  
  For documentation of @code{altivec} attribute please see the
! documentation in the @xref{PowerPC Type Attributes}, section.
  
  @subsection SPU Variable Attributes
  
  The SPU supports the @code{spu_vector} attribute for variables.  For
! documentation of this attribute please see the documentation in the
! @xref{SPU Type Attributes}, section.
  
  @subsection Xstormy16 Variable Attributes
  
  One attribute is currently defined for xstormy16 configurations:
! @code{below100}
  
  @table @code
  @item below100
--- 3955,3975 ----
  @code{altivec}, @code{ms_struct} and @code{gcc_struct}.
  
  For full documentation of the struct attributes please see the
! documentation in @ref{i386 Variable Attributes}.
  
  For documentation of @code{altivec} attribute please see the
! documentation in @ref{PowerPC Type Attributes}.
  
  @subsection SPU Variable Attributes
  
  The SPU supports the @code{spu_vector} attribute for variables.  For
! documentation of this attribute please see the documentation in
! @ref{SPU Type Attributes}.
  
  @subsection Xstormy16 Variable Attributes
  
  One attribute is currently defined for xstormy16 configurations:
! @code{below100}.
  
  @table @code
  @item below100
*************** and caught in another, the class must ha
*** 4283,4288 ****
--- 4283,4290 ----
  Otherwise the two shared objects will be unable to use the same
  typeinfo node and exception handling will break.
  
+ @end table
+ 
  @subsection ARM Type Attributes
  
  On those ARM targets that support @code{dllimport} (such as Symbian
*************** most Symbian OS code uses @code{__declsp
*** 4310,4316 ****
  @subsection i386 Type Attributes
  
  Two attributes are currently defined for i386 configurations:
! @code{ms_struct} and @code{gcc_struct}
  
  @item ms_struct
  @itemx gcc_struct
--- 4312,4320 ----
  @subsection i386 Type Attributes
  
  Two attributes are currently defined for i386 configurations:
! @code{ms_struct} and @code{gcc_struct}.
! 
! @table @code
  
  @item ms_struct
  @itemx gcc_struct
*************** packed))}.
*** 4338,4345 ****
  Three attributes currently are defined for PowerPC configurations:
  @code{altivec}, @code{ms_struct} and @code{gcc_struct}.
  
! For full documentation of the struct attributes please see the
! documentation in the @xref{i386 Type Attributes}, section.
  
  The @code{altivec} attribute allows one to declare AltiVec vector data
  types supported by the AltiVec Programming Interface Manual.  The
--- 4342,4349 ----
  Three attributes currently are defined for PowerPC configurations:
  @code{altivec}, @code{ms_struct} and @code{gcc_struct}.
  
! For full documentation of the @code{ms_struct} and @code{gcc_struct} 
! attributes please see the documentation in @ref{i386 Type Attributes}.
  
  The @code{altivec} attribute allows one to declare AltiVec vector data
  types supported by the AltiVec Programming Interface Manual.  The
*************** GCC provides three magic variables which
*** 5283,5289 ****
  function, as a string.  The first of these is @code{__func__}, which
  is part of the C99 standard:
  
- @display
  The identifier @code{__func__} is implicitly declared by the translator
  as if, immediately following the opening brace of each function
  definition, the declaration
--- 5287,5292 ----
*************** definition, the declaration
*** 5292,5300 ****
  static const char __func__[] = "function-name";
  @end smallexample
  
  appeared, where function-name is the name of the lexically-enclosing
  function.  This name is the unadorned name of the function.
- @end display
  
  @code{__FUNCTION__} is another name for @code{__func__}.  Older
  versions of GCC recognize only this name.  However, it is not
--- 5295,5303 ----
  static const char __func__[] = "function-name";
  @end smallexample
  
+ @noindent
  appeared, where function-name is the name of the lexically-enclosing
  function.  This name is the unadorned name of the function.
  
  @code{__FUNCTION__} is another name for @code{__func__}.  Older
  versions of GCC recognize only this name.  However, it is not
*************** interface table mechanism, instead of re
*** 12316,12322 ****
  
  @end table
  
! See also @xref{Namespace Association}.
  
  @node Namespace Association
  @section Namespace Association
--- 12319,12325 ----
  
  @end table
  
! See also @ref{Namespace Association}.
  
  @node Namespace Association
  @section Namespace Association
*************** should work just fine for standard-confo
*** 12543,12549 ****
  Previously it was possible to use an empty prototype parameter list to
  indicate an unspecified number of parameters (like C), rather than no
  parameters, as C++ demands.  This feature has been removed, except where
! it is required for backwards compatibility @xref{Backwards Compatibility}.
  @end table
  
  G++ allows a virtual function returning @samp{void *} to be overridden
--- 12546,12552 ----
  Previously it was possible to use an empty prototype parameter list to
  indicate an unspecified number of parameters (like C), rather than no
  parameters, as C++ demands.  This feature has been removed, except where
! it is required for backwards compatibility.   @xref{Backwards Compatibility}.
  @end table
  
  G++ allows a virtual function returning @samp{void *} to be overridden
*************** used to be acceptable in previous drafts
*** 12594,12600 ****
  compilation of C++ written to such drafts, G++ contains some backwards
  compatibilities.  @emph{All such backwards compatibility features are
  liable to disappear in future versions of G++.} They should be considered
! deprecated @xref{Deprecated Features}.
  
  @table @code
  @item For scope
--- 12597,12603 ----
  compilation of C++ written to such drafts, G++ contains some backwards
  compatibilities.  @emph{All such backwards compatibility features are
  liable to disappear in future versions of G++.} They should be considered
! deprecated.   @xref{Deprecated Features}.
  
  @table @code
  @item For scope
Index: gcc/doc/rtl.texi
===================================================================
*** gcc/doc/rtl.texi	(revision 137047)
--- gcc/doc/rtl.texi	(working copy)
*************** represents @var{x} before @var{x} is mod
*** 3188,3198 ****
  @var{m} must be the machine mode for pointers on the machine in use.
  
  The expression @var{y} must be one of three forms:
- @table @code
  @code{(plus:@var{m} @var{x} @var{z})},
  @code{(minus:@var{m} @var{x} @var{z})}, or
  @code{(plus:@var{m} @var{x} @var{i})},
- @end table
  where @var{z} is an index register and @var{i} is a constant.
  
  Here is an example of its use:
--- 3188,3196 ----

Re: PATCH: [doc] fix texinfo markup errors

[Gerald Pfeifer]

On Mon, 23 Jun 2008, Sandra Loosemore wrote:
> This patch fixes some invalid texinfo markup in the GCC manuals that I 
> found while experimenting with makeinfo --docbook.  I also fixed some 
> @ref/@xref confusion I noted nearby.  OK to apply?  I'm not sure if this 
> sort of thing qualifies as "obvious" or not....  better to be safe and 
> ask first.  :-)

I believe nobody might have complained had you committed this as
"obvious" ;-), but I had a look as well and the changes seem fine.

Thanks for taking the time to make these cleanup, Sandra!

Gerald