diff options
author | Ralf Wildenhues <Ralf.Wildenhues@gmx.de> | 2010-09-22 20:22:51 +0000 |
---|---|---|
committer | Ralf Wildenhues <rwild@gcc.gnu.org> | 2010-09-22 20:22:51 +0000 |
commit | ab940b73bfabe2cec4a26887f959c868388f5117 (patch) | |
tree | 2adfb70df9f3f8a0a39ba59bde6a9fda1e0c5b13 /gcc/doc/extend.texi | |
parent | 60cf253a8b1ebaabf6dd476a1177a24ab7f6d48c (diff) | |
download | gcc-ab940b73bfabe2cec4a26887f959c868388f5117.zip gcc-ab940b73bfabe2cec4a26887f959c868388f5117.tar.gz gcc-ab940b73bfabe2cec4a26887f959c868388f5117.tar.bz2 |
Improve formatting of manuals.
contrib/:
* texi2pod.pl: Replace @@ before @{ and @}, for @samp{@@}.
Also escape characters with grave accents, to be fixed ...
(unmunge): ... here.
(postprocess): Also handle @/ and @acronym{...}.
gcc/:
* doc/contrib.texi (Contributors): Allow URL to wrap in PDF
output.
* doc/cppopts.texi: Fix markup of index entry.
* doc/extend.texi (Constructing Calls): Fix markup of
__builtin_va_arg_pack and __builtin_va_arg_pack_len definition.
(Conditionals, C++ Comments, Pragmas, Unnamed Fields, Thread-Local)
(Vague Linkage, C++ Attributes): Fix markup of index entries and
keywords.
* doc/invoke.texi (Option Summary): Fix spacing. Rewrap to
avoid long lines.
(C Dialect Options, C++ Dialect Options, Warning Options)
(Debugging Options, Spec Files, Darwin Options)
(i386 and x86-64 Options, MIPS Options)
(RS/6000 and PowerPC Options, Code Gen Options): Fix markup of
index entries, avoid abbreviations, allow URLs to wrap, avoid
long lines, avoid overlong pages from long @itemx lists.
* doc/objc.texi (Garbage Collection): Allow URLs to wrap.
* doc/standards.texi (Standards): Likewise.
* doc/trouble.texi (Incompatibilities): Fix markup of index
entry.
gcc/fortran/:
* gfortran.texi (Argument list functions): Allow URL to wrap.
* intrinsic.texi (GETGID, GETPID, GETUID, IMAGE_INDEX)
(IS_IOSTAT_END, IS_IOSTAT_EOR, NUM_IMAGES, THIS_IMAGE)
(ISO_FORTRAN_ENV): Fix markup in index entries, and a couple of
code markups in the text.
* invoke.texi (Fortran Dialect Options)
(Error and Warning Options, Directory Options, Code Gen Options):
Likewise. Remove @code inside @smallexample.
From-SVN: r164533
Diffstat (limited to 'gcc/doc/extend.texi')
-rw-r--r-- | gcc/doc/extend.texi | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/gcc/doc/extend.texi b/gcc/doc/extend.texi index 4f2cc07..d737617a 100644 --- a/gcc/doc/extend.texi +++ b/gcc/doc/extend.texi @@ -568,7 +568,7 @@ the containing function. You should specify, for @var{result}, a value returned by @code{__builtin_apply}. @end deftypefn -@deftypefn {Built-in Function} __builtin_va_arg_pack () +@deftypefn {Built-in Function} {} __builtin_va_arg_pack () This built-in function represents all anonymous arguments of an inline function. It can be used only in inline functions which will be always inlined, never compiled as a separate function, such as those using @@ -594,7 +594,7 @@ myprintf (FILE *f, const char *format, ...) @end smallexample @end deftypefn -@deftypefn {Built-in Function} __builtin_va_arg_pack_len () +@deftypefn {Built-in Function} {size_t} __builtin_va_arg_pack_len () This built-in function returns the number of anonymous arguments of an inline function. It can be used only in inline functions which will be always inlined, never compiled as a separate function, such @@ -796,8 +796,8 @@ This example is perfectly equivalent to x ? x : y @end smallexample -@cindex side effect in ?: -@cindex ?: side effect +@cindex side effect in @code{?:} +@cindex @code{?:} side effect @noindent In this simple case, the ability to omit the middle operand is not especially useful. When it becomes useful is when the first operand does, @@ -3900,7 +3900,7 @@ extension is irrelevant. @node C++ Comments @section C++ Style Comments -@cindex // +@cindex @code{//} @cindex C++ comments @cindex comments, C++ style @@ -12370,7 +12370,7 @@ bit-fields. See the Solaris man page for @code{cmn_err} for more information. @node Pragmas @section Pragmas Accepted by GCC @cindex pragmas -@cindex #pragma +@cindex @code{#pragma} GCC supports several types of pragmas, primarily in order to compile code originally written for other compilers. Note that in general @@ -12936,8 +12936,8 @@ versions earlier than 4.4. @node Unnamed Fields @section Unnamed struct/union fields within structs/unions -@cindex struct -@cindex union +@cindex @code{struct} +@cindex @code{union} As permitted by ISO C1X and for compatibility with other compilers, GCC allows you to define @@ -12989,7 +12989,7 @@ previously defined structure or union type with a tag. @section Thread-Local Storage @cindex Thread-Local Storage @cindex @acronym{TLS} -@cindex __thread +@cindex @code{__thread} Thread-local storage (@acronym{TLS}) is a mechanism by which variables are allocated such that there is one instance of the variable per extant @@ -13442,15 +13442,15 @@ vtable will still be emitted in every translation unit which defines it. Make sure that any inline virtuals are declared inline in the class body, even if they are not defined there. -@item type_info objects -@cindex type_info +@item @code{type_info} objects +@cindex @code{type_info} @cindex RTTI C++ requires information about types to be written out in order to implement @samp{dynamic_cast}, @samp{typeid} and exception handling. -For polymorphic classes (classes with virtual functions), the type_info +For polymorphic classes (classes with virtual functions), the @samp{type_info} object is written out along with the vtable so that @samp{dynamic_cast} can determine the dynamic type of a class object at runtime. For all -other types, we write out the type_info object when it is used: when +other types, we write out the @samp{type_info} object when it is used: when applying @samp{typeid} to an expression, throwing an object, or referring to a type in a catch clause or exception specification. @@ -13770,7 +13770,7 @@ Some attributes only make sense for C++ programs. @table @code @item init_priority (@var{priority}) -@cindex init_priority attribute +@cindex @code{init_priority} attribute In Standard C++, objects defined at namespace scope are guaranteed to be @@ -13795,7 +13795,7 @@ Note that the particular values of @var{priority} do not matter; only their relative ordering. @item java_interface -@cindex java_interface attribute +@cindex @code{java_interface} attribute This type attribute informs C++ that the class is a Java interface. It may only be applied to classes declared within an @code{extern "Java"} block. |