Re: PATCH: misc documentation patches

[Lars Brinkhoff <lars dot spam at nocrew dot org>]

This patch is unreviewed since April 20.  I have updated it and tested
it with "make info" and "make dvi".

2001-05-08  lars brinkhoff  <lars@nocrew.org>

        * gcc.texi (HOST_BITS_PER_LONGLONG): Document.
        (DIR_SEPARATOR_2): Likewise.
	* md.texi (cbranch@var{mode}4): Likewise.
	* rtl.texi (REG_POINTER): Likewise.
        (Machine Modes): Document QFmode, HFmode, TQFmode, QCmode, and
	HCmode.
	* tm.texi (TARGET_FLOAT_FORMAT): Document IBM_FLOAT_FORMAT
	and C4X_FLOAT_FORMAT.
        (BOOL_TYPE_SIZE): Document.

Index: gcc.texi
===================================================================
RCS file: /cvs/gcc/gcc/gcc/gcc.texi,v
retrieving revision 1.84
diff -c -3 -p -r1.84 gcc.texi
*** gcc.texi	2001/05/01 00:39:58	1.84
--- gcc.texi	2001/05/08 13:18:01
*************** machine.
*** 4036,4041 ****
--- 4036,4046 ----
  A C expression for the number of bits in @code{long} on the host
  machine.
  
+ @findex HOST_BITS_PER_LONGLONG
+ @item HOST_BITS_PER_LONGLONG
+ A C expression for the number of bits in @code{long long} on the host
+ machine.
+ 
  @findex ONLY_INT_FIELDS
  @item ONLY_INT_FIELDS
  Define this macro to indicate that the host compiler only supports
*************** directory names within a file specificat
*** 4109,4114 ****
--- 4114,4127 ----
  character constant specifying that character.  When GCC displays file
  names, the character you specify will be used.  GCC will test for
  both slash and the character you specify when parsing filenames.
+ 
+ @findex DIR_SEPARATOR_2
+ @item DIR_SEPARATOR_2
+ If your system uses an alternative character other than
+ @samp{DIR_SEPARATOR} to separate directory names within a file
+ specification, define this macro to be a C character constant specifying
+ that character.  If you define this macro, GCC will test for slash,
+ @samp{DIR_SEPARATOR}, and @samp{DIR_SEPARATOR_2} when parsing filenames.
  
  @findex TARGET_OBJECT_SUFFIX
  @item TARGET_OBJECT_SUFFIX
Index: md.texi
===================================================================
RCS file: /cvs/gcc/gcc/gcc/md.texi,v
retrieving revision 1.61
diff -c -3 -p -r1.61 md.texi
*** md.texi	2001/04/28 08:54:31	1.61
--- md.texi	2001/05/08 13:18:04
*************** tested, should also use the above mechan
*** 2458,2463 ****
--- 2458,2472 ----
  The above discussion also applies to the @samp{mov@var{mode}cc} and
  @samp{s@var{cond}} patterns.
  
+ @c cmov@var{mode}6
+ 
+ @c cstore@var{mode}4
+ 
+ @cindex @code{cbranch@var{mode}4} instruction pattern
+ @item @samp{cbranch@var{mode}4}
+ Conditional branch instruction.  Jump to operand 3 if the comparison
+ in operand 0 between operand 1 and operand 2 is true.
+ 
  @cindex @code{jump} instruction pattern
  @item @samp{jump}
  A jump inside a function; an unconditional branch.  Operand 0 is the
Index: rtl.texi
===================================================================
RCS file: /cvs/gcc/gcc/gcc/rtl.texi,v
retrieving revision 1.38
diff -c -3 -p -r1.38 rtl.texi
*** rtl.texi	2001/04/19 19:44:12	1.38
--- rtl.texi	2001/05/08 13:18:06
*************** The same hard register may be used also 
*** 415,420 ****
--- 415,428 ----
  functions called by this one, but @code{REG_FUNCTION_VALUE_P} is zero
  in this kind of use.
  
+ @cindex @samp{/f} in RTL dump
+ @findex REG_POINTER
+ @cindex @code{reg} and @samp{/f}
+ @cindex @code{frame_related}, in @code{reg}
+ @item REG_POINTER (@var{x})
+ Nonzero in a @code{reg} if the register holds a pointer.  Stored in the
+ @code{frame_related} field and printed as @samp{/f}.
+ 
  @findex SUBREG_PROMOTED_VAR_P
  @cindex @code{subreg} and @samp{/s}
  @cindex @code{in_struct}, in @code{subreg}
*************** this is the right mode to use for certai
*** 725,730 ****
--- 733,753 ----
  @item OImode
  ``Octa Integer'' (?) mode represents a thirty-two-byte integer.
  
+ @findex QFmode
+ @item QFmode
+ ``Quarter-Floating'' mode represents a quarter-precision (single byte)
+ floating point number.
+ 
+ @findex HFmode
+ @item HFmode
+ ``Half-Floating'' mode represents a half-precision (two byte) floating
+ point number.
+ 
+ @findex TQFmode
+ @item TQFmode
+ ``Three-Quarter-Floating'' (?) mode represents a three-quarter-precision
+ (three byte) floating point number.
+ 
  @findex SFmode
  @item SFmode
  ``Single Floating'' mode represents a single-precision (four byte) floating
*************** For example, RTL expressions of code @co
*** 770,783 ****
  requires.  In debugging dumps of RTL, @code{VOIDmode} is expressed by
  the absence of any mode.
  
  @findex SCmode
  @findex DCmode
  @findex XCmode
  @findex TCmode
! @item SCmode, DCmode, XCmode, TCmode
  These modes stand for a complex number represented as a pair of floating
! point values.  The floating point values are in @code{SFmode},
! @code{DFmode}, @code{XFmode}, and @code{TFmode}, respectively.
  
  @findex CQImode
  @findex CHImode
--- 793,809 ----
  requires.  In debugging dumps of RTL, @code{VOIDmode} is expressed by
  the absence of any mode.
  
+ @findex QCmode
+ @findex HCmode
  @findex SCmode
  @findex DCmode
  @findex XCmode
  @findex TCmode
! @item QCmode, HCmode, SCmode, DCmode, XCmode, TCmode
  These modes stand for a complex number represented as a pair of floating
! point values.  The floating point values are in @code{QFmode},
! @code{HFmode}, @code{SFmode}, @code{DFmode}, @code{XFmode}, and
! @code{TFmode}, respectively.
  
  @findex CQImode
  @findex CHImode
*************** mode classes are:
*** 815,830 ****
  @table @code
  @findex MODE_INT
  @item MODE_INT
! Integer modes.  By default these are @code{QImode}, @code{HImode},
! @code{SImode}, @code{DImode}, and @code{TImode}.
  
  @findex MODE_PARTIAL_INT
  @item MODE_PARTIAL_INT
! The ``partial integer'' modes, @code{PSImode} and @code{PDImode}.
  
  @findex MODE_FLOAT
  @item MODE_FLOAT
! floating point modes.  By default these are @code{SFmode}, @code{DFmode},
  @code{XFmode} and @code{TFmode}.
  
  @findex MODE_COMPLEX_INT
--- 841,859 ----
  @table @code
  @findex MODE_INT
  @item MODE_INT
! Integer modes.  By default these are @code{BImode}, @code{QImode},
! @code{HImode}, @code{SImode}, @code{DImode}, @code{TImode}, and
! @code{OImode}.
  
  @findex MODE_PARTIAL_INT
  @item MODE_PARTIAL_INT
! The ``partial integer'' modes, @code{PQImode}, @code{PHImode},
! @code{PSImode} and @code{PDImode}.
  
  @findex MODE_FLOAT
  @item MODE_FLOAT
! Floating point modes.  By default these are @code{QFmode},
! @code{HFmode}, @code{TQFmode}, @code{SFmode}, @code{DFmode},
  @code{XFmode} and @code{TFmode}.
  
  @findex MODE_COMPLEX_INT
*************** Complex integer modes.  (These are not c
*** 833,840 ****
  
  @findex MODE_COMPLEX_FLOAT
  @item MODE_COMPLEX_FLOAT
! Complex floating point modes.  By default these are @code{SCmode},
! @code{DCmode}, @code{XCmode}, and @code{TCmode}.
  
  @findex MODE_FUNCTION
  @item MODE_FUNCTION
--- 862,870 ----
  
  @findex MODE_COMPLEX_FLOAT
  @item MODE_COMPLEX_FLOAT
! Complex floating point modes.  By default these are @code{QCmode},
! @code{HCmode}, @code{SCmode}, @code{DCmode}, @code{XCmode}, and
! @code{TCmode}.
  
  @findex MODE_FUNCTION
  @item MODE_FUNCTION
Index: tm.texi
===================================================================
RCS file: /cvs/gcc/gcc/gcc/tm.texi,v
retrieving revision 1.184
diff -c -3 -p -r1.184 tm.texi
*** tm.texi	2001/04/29 00:12:50	1.184
--- tm.texi	2001/05/08 13:18:11
*************** This macro need not be defined if there 
*** 1215,1221 ****
  @findex TARGET_FLOAT_FORMAT
  @item TARGET_FLOAT_FORMAT
  A code distinguishing the floating point format of the target machine.
! There are three defined values:
  
  @table @code
  @findex IEEE_FLOAT_FORMAT
--- 1215,1221 ----
  @findex TARGET_FLOAT_FORMAT
  @item TARGET_FLOAT_FORMAT
  A code distinguishing the floating point format of the target machine.
! There are five defined values:
  
  @table @code
  @findex IEEE_FLOAT_FORMAT
*************** need to define this macro when the forma
*** 1227,1232 ****
--- 1227,1240 ----
  @item VAX_FLOAT_FORMAT
  This code indicates the peculiar format used on the Vax.
  
+ @findex IBM_FLOAT_FORMAT
+ @item IBM_FLOAT_FORMAT
+ This code indicates the format used on the IBM System/370.
+ 
+ @findex C4X_FLOAT_FORMAT
+ @item C4X_FLOAT_FORMAT
+ This code indicates the format used on the TMS320C3x/C4x.
+ 
  @findex UNKNOWN_FLOAT_FORMAT
  @item UNKNOWN_FLOAT_FORMAT
  This code indicates any other format.
*************** target machine.  If this is undefined, t
*** 1317,1322 ****
--- 1325,1336 ----
  @code{CHAR_TYPE_SIZE}.  Otherwise, it is the constant value that is the
  largest value that @code{CHAR_TYPE_SIZE} can have at run-time.  This is
  used in @code{cpp}.
+ 
+ @findex BOOL_TYPE_SIZE
+ @item BOOL_TYPE_SIZE
+ A C expression for the size in bits of the C++ type @code{bool} on the
+ target machine.  If you don't define this, the default is
+ @code{CHAR_TYPE_SIZE}.
  
  @findex FLOAT_TYPE_SIZE
  @item FLOAT_TYPE_SIZE