From: Joseph Myers Date: Wed, 27 Jun 2001 00:04:39 +0000 (+0100) Subject: cpp.texi, [...]: Use @: where necessary when a full stop does not end a sentence. X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=e979f9e88c46abb7c45dd2dacf79085a26d48301;p=gcc.git cpp.texi, [...]: Use @: where necessary when a full stop does not end a sentence. * doc/cpp.texi, doc/cppinternals.texi, doc/extend.texi, doc/gcc.texi, doc/install.texi, doc/invoke.texi, doc/md.texi, doc/tm.texi: Use @: where necessary when a full stop does not end a sentence. From-SVN: r43600 --- diff --git a/gcc/ChangeLog b/gcc/ChangeLog index b8e55c9594d..10db88e33ef 100644 --- a/gcc/ChangeLog +++ b/gcc/ChangeLog @@ -1,3 +1,10 @@ +2001-06-27 Joseph S. Myers + + * doc/cpp.texi, doc/cppinternals.texi, doc/extend.texi, + doc/gcc.texi, doc/install.texi, doc/invoke.texi, doc/md.texi, + doc/tm.texi: Use @: where necessary when a full stop does not end + a sentence. + 2001-06-27 Joseph S. Myers * doc/gcc.texi, doc/install.texi, doc/invoke.texi: Remove trailing diff --git a/gcc/doc/cpp.texi b/gcc/doc/cpp.texi index 26c1578dff2..ce67981976c 100644 --- a/gcc/doc/cpp.texi +++ b/gcc/doc/cpp.texi @@ -864,7 +864,7 @@ generally less useful. @xref{Invocation}. @cindex wrapper @code{#ifndef} If a header file happens to be included twice, the compiler will process -its contents twice. This is very likely to cause an error, e.g. when the +its contents twice. This is very likely to cause an error, e.g.@: when the compiler sees the same structure definition twice. Even if it does not, it will certainly waste time. @@ -1954,7 +1954,7 @@ the @code{m68k-aout} environment it expands to an @samp{_}, but in the This macro will have the correct definition even if @option{-f(no-)underscores} is in use, but it will not be correct if -target-specific options that adjust this prefix are used (e.g. the +target-specific options that adjust this prefix are used (e.g.@: the OSF/rose @option{-mno-underscores} option). @item __SIZE_TYPE__ @@ -3187,7 +3187,7 @@ discarded. The ISO standard specifies that it is implementation defined whether a preprocessor preserves whitespace between tokens, or replaces it with -e.g. a single space. In GNU CPP, whitespace between tokens is collapsed +e.g.@: a single space. In GNU CPP, whitespace between tokens is collapsed to become a single space, with the exception that the first token on a non-directive line is preceded with sufficient spaces that it appears in the same column in the preprocessed output that it appeared in in the @@ -3325,7 +3325,7 @@ and the tokens to be pasted. @item Traditional mode preserves the amount and form of whitespace provided by -the user. Hard tabs remain hard tabs. This can be useful, e.g. if you +the user. Hard tabs remain hard tabs. This can be useful, e.g.@: if you are preprocessing a Makefile (which we do not encourage). @end itemize diff --git a/gcc/doc/cppinternals.texi b/gcc/doc/cppinternals.texi index 44e42ee3dd5..ac7088f8783 100644 --- a/gcc/doc/cppinternals.texi +++ b/gcc/doc/cppinternals.texi @@ -131,7 +131,7 @@ the lexer to only step forwards through the input files, and not step back. This will make future changes to support different character sets, in particular state or shift-dependent ones, much easier. -This file also contains all information needed to spell a token, i.e. to +This file also contains all information needed to spell a token, i.e.@: to output it either in a diagnostic or to a preprocessed output file. This information is not exported, but made available to clients through such functions as @samp{cpp_spell_token} and @samp{cpp_token_len}. diff --git a/gcc/doc/extend.texi b/gcc/doc/extend.texi index 152d6de65fd..334875fe332 100644 --- a/gcc/doc/extend.texi +++ b/gcc/doc/extend.texi @@ -948,7 +948,7 @@ Non-empty initialization of zero-length arrays is now deprecated. Instead GCC allows static initialization of flexible array members. This is equivalent to defining a new structure containing the original structure followed by an array of sufficient size to contain the data. -I.e. in the following, @code{f1} is constructed as if it were declared +I.e.@: in the following, @code{f1} is constructed as if it were declared like @code{f2}. @example @@ -3440,7 +3440,7 @@ you recompile them specially for the task at hand). @cindex @code{qsort}, and global register variables It is not safe for one function that uses a global register variable to call another such function @code{foo} by way of a third function -@code{lose} that was compiled without knowledge of this variable (i.e. in a +@code{lose} that was compiled without knowledge of this variable (i.e.@: in a different source file in which the variable wasn't declared). This is because @code{lose} might save the register and put some other value there. For example, you can't expect a global register variable to be available in @@ -4430,7 +4430,7 @@ other files) without having to specify them as well. g++ has extended the template instantiation syntax outlined in the Working Paper to allow forward declaration of explicit instantiations (with @code{extern}), instantiation of the compiler support data for a -template class (i.e. the vtable) without instantiating any of its +template class (i.e.@: the vtable) without instantiating any of its members (with @code{inline}), and instantiation of only the static data members of a template class, without the support data or member functions (with (@code{static}): @@ -4455,7 +4455,7 @@ definitions. For each of these files, add @samp{#pragma implementation "@var{filename}"} to the top of some @samp{.C} file which @samp{#include}s it. Then compile everything with @option{-fexternal-templates}. The templates will then only be expanded -in the translation unit which implements them (i.e. has a @samp{#pragma +in the translation unit which implements them (i.e.@: has a @samp{#pragma implementation} line for the file where they live); all other files will use external references. If you're lucky, everything should work properly. If you get undefined symbol errors, you need to make sure @@ -4518,7 +4518,7 @@ typedef int (*fptr)(A *); fptr p = (fptr)(a.*fp); @end example -For PMF constants (i.e. expressions of the form @samp{&Klasse::Member}), +For PMF constants (i.e.@: expressions of the form @samp{&Klasse::Member}), no object is needed to obtain the address of the function. They can be converted to function pointers directly: diff --git a/gcc/doc/gcc.texi b/gcc/doc/gcc.texi index b834a0fbce4..f246d44f28d 100644 --- a/gcc/doc/gcc.texi +++ b/gcc/doc/gcc.texi @@ -1153,8 +1153,8 @@ it when @option{-traditional} is used, but it is too much work to implement. @item -K&R compilers allow comments to cross over an inclusion boundary (i.e. -started in an include file and ended in the including file). I think +K&R compilers allow comments to cross over an inclusion boundary +(i.e.@: started in an include file and ended in the including file). I think this would be quite ugly and can't imagine it could be needed. @cindex external declaration scope @@ -2603,7 +2603,7 @@ preprocessor then uses this name with no prefix in an attempt to open the include file. @item -If the file specification is not a valid VMS filename (i.e. does not +If the file specification is not a valid VMS filename (i.e.@: does not contain a device or a directory specifier, and contains a @samp{/} character), the preprocessor tries to convert it from Unix syntax to VMS syntax. diff --git a/gcc/doc/install.texi b/gcc/doc/install.texi index 43a9a7c2743..0729e486b04 100644 --- a/gcc/doc/install.texi +++ b/gcc/doc/install.texi @@ -33,7 +33,7 @@ @settitle Installing GCC: Binaries @end ifset -@comment $Id: install.texi,v 1.35 2001/06/26 22:47:09 jsm28 Exp $ +@comment $Id: install.texi,v 1.36 2001/06/26 23:23:32 jsm28 Exp $ @c Copyright (C) 2001 Free Software Foundation, Inc. @c *** Converted to texinfo by Dean Wakerley, dean@wakerley.com @@ -438,7 +438,7 @@ defaults to @file{/usr/local} unless overridden by the target system triple, such as @var{sparc-sun-solaris2.7}, and @var{version} denotes the GCC version, such as 2.95.2. @item -Check operating system specific directories (e.g. @file{/usr/ccs/bin} on +Check operating system specific directories (e.g.@: @file{/usr/ccs/bin} on Sun Solaris). @end itemize Note that these rules do not check for the value of @env{PATH}. You may @@ -545,7 +545,7 @@ Microsoft Win32 API thread support. Specify which cpu variant the compiler should generate code for by default. This is currently only supported on the some ports, specifically arm, powerpc, and -SPARC. If configure does not recognize the model name (e.g. arm700, +SPARC. If configure does not recognize the model name (e.g.@: arm700, 603e, or ultrasparc) you provide, please check the configure script for a complete list of supported models. @@ -923,7 +923,7 @@ Now you may need specific preparations: @item In order to run the libio tests in GCC 2.95 and earlier versions of GCC on targets which do not fully -support Unix/POSIX commands (e.g. Cygwin), the references to the @file{dbz} +support Unix/POSIX commands (e.g.@: Cygwin), the references to the @file{dbz} directory have to be deleted from @file{libio/configure.in}. @item @@ -2311,7 +2311,7 @@ raises some of the arbitrary limits found in the original.
@end html @heading @anchor{m68k-att-sysv}m68k-att-sysv -AT&T 3b1, a.k.a. 7300 PC. This version of GCC cannot +AT&T 3b1, a.k.a.@: 7300 PC. This version of GCC cannot be compiled with the system C compiler, which is too buggy. You will need to get a previous version of GCC and use it to bootstrap. Binaries are available from the OSU-CIS archive, at @@ -2784,7 +2784,7 @@ smaller than 16 bytes and which are not 8 bytes. The problem is very involved and difficult to fix. It affects a number of other targets also, but IRIX 6 is affected the most, because it is a 64 bit target, and 4 byte structures are common. The exact problem is that structures are being padded -at the wrong end, e.g. a 4 byte structure is loaded into the lower 4 bytes +at the wrong end, e.g.@: a 4 byte structure is loaded into the lower 4 bytes of the register when it should be loaded into the upper 4 bytes of the register. diff --git a/gcc/doc/invoke.texi b/gcc/doc/invoke.texi index 899fef63405..94d4e0c06de 100644 --- a/gcc/doc/invoke.texi +++ b/gcc/doc/invoke.texi @@ -917,7 +917,7 @@ possible values are Same as @option{-ansi} @item iso9899:199409 -ISO C as modified in amend. 1 +ISO C as modified in amendment 1 @item iso9899:1999 ISO C99. Note that this standard is not yet fully supported; see @@ -1371,7 +1371,7 @@ be removed from a future version of G++. @item -fno-implicit-templates @opindex fno-implicit-templates Never emit code for non-inline templates which are instantiated -implicitly (i.e. by use); only emit code for explicit instantiations. +implicitly (i.e.@: by use); only emit code for explicit instantiations. @xref{Template Instantiation}, for more information. @item -fno-implicit-inline-templates @@ -1685,9 +1685,9 @@ Warn if a selector has multiple methods of different types defined. @cindex message formatting Traditionally, diagnostic messages have been formatted irrespective of -the output device's aspect (e.g. its width, @dots{}). The options described +the output device's aspect (e.g.@: its width, @dots{}). The options described below can be used to control the diagnostic messages formatting -algorithm, e.g. how many characters per line, how often source location +algorithm, e.g.@: how many characters per line, how often source location information should be reported. Right now, only the C++ front end can honor these options. However it is expected, in the near future, that the remaining front ends would be able to digest them correctly. @@ -2305,7 +2305,7 @@ The unary plus operator. The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point constant suffixes. (Traditional C does support the @samp{L} suffix on integer constants.) Note, these suffixes appear in macros defined in the system -headers of most modern systems, e.g. the @samp{_MIN}/@samp{_MAX} macros in @code{}. +headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{}. Use of these macros in user code might normally lead to spurious warnings, however gcc's integrated preprocessor has enough context to avoid warning in these cases. @@ -2324,7 +2324,7 @@ This construct is not accepted by some traditional C compilers. @item The ISO type of an integer constant has a different width or signedness from its traditional type. This warning is only issued if -the base of the constant is ten. I.e. hexadecimal or octal values, which +the base of the constant is ten. I.e.@: hexadecimal or octal values, which typically represent bit patterns, are not warned about. @item @@ -2340,7 +2340,7 @@ namespace for labels. @item Initialization of unions. If the initializer is zero, the warning is omitted. This is done under the assumption that the zero initializer in -user code appears conditioned on e.g. @code{__STDC__} to avoid missing +user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing initializer warnings and relies on default initialization to zero in the traditional C case. @@ -4813,7 +4813,7 @@ string after this option will not. @item %@{@code{S}*:@code{X}@} Substitutes @code{X} if one or more switches whose names start with @code{-S} are specified to GCC. Note that the tail part of the -@code{-S} option (i.e. the part matched by the @samp{*}) will be substituted +@code{-S} option (i.e.@: the part matched by the @samp{*}) will be substituted for each occurrence of @samp{%*} within @code{X}. @item %@{@code{S}:@code{X}@} @@ -4983,7 +4983,7 @@ command with the @option{-V} option. Earlier we discussed the standard option @option{-b} which chooses among different installed compilers for completely different target -machines, such as Vax vs. 68000 vs. 80386. +machines, such as Vax vs.@: 68000 vs.@: 80386. In addition, each of these target machine types can have its own special options, starting with @samp{-m}, to choose among various @@ -5871,7 +5871,7 @@ objects in memory. @opindex mno-alignment-traps Generate code that assumes that the MMU will not trap unaligned accesses. This produces better code when the target instruction set -does not have half-word memory operations (i.e. implementations prior to +does not have half-word memory operations (i.e.@: implementations prior to ARMv4). Note that you cannot use this option to access unaligned word objects, @@ -8047,7 +8047,7 @@ Produce code for a C300 Clipper processor. This is the default. @item -mc400 @opindex mc400 -Produce code for a C400 Clipper processor i.e. use floating point +Produce code for a C400 Clipper processor i.e.@: use floating point registers f8---f15. @end table @@ -8941,7 +8941,7 @@ use exception handling. Generate code that allows trapping instructions to throw exceptions. Note that this requires platform-specific runtime support that does not exist everywhere. Moreover, it only allows @emph{trapping} -instructions to throw exceptions, i.e. memory references or floating +instructions to throw exceptions, i.e.@: memory references or floating point instructions. It does not allow exceptions to be thrown from arbitrary signal handlers such as @code{SIGALRM}. diff --git a/gcc/doc/md.texi b/gcc/doc/md.texi index 9713c909dcb..18498275c59 100644 --- a/gcc/doc/md.texi +++ b/gcc/doc/md.texi @@ -383,7 +383,7 @@ predicate function, and that function is solely responsible for deciding whether the expression to be matched ``has'' that mode. When constructing an insn, argument 3 of the gen-function will specify -the operation (i.e. the expression code) for the expression to be +the operation (i.e.@: the expression code) for the expression to be made. It should be an RTL expression, whose expression code is copied into a new expression whose operands are arguments 1 and 2 of the gen-function. The subexpressions of argument 3 are not used; @@ -2519,8 +2519,8 @@ This instruction pattern should be defined to support @code{__builtin_apply} on machines where special instructions are needed to call a subroutine with arbitrary arguments or to save the value returned. This instruction pattern is required on machines that have -multiple registers that can hold a return value (i.e. -@code{FUNCTION_VALUE_REGNO_P} is true for more than one register). +multiple registers that can hold a return value +(i.e.@: @code{FUNCTION_VALUE_REGNO_P} is true for more than one register). @cindex @code{return} instruction pattern @item @samp{return} @@ -4930,7 +4930,7 @@ if the current insn is predicated, and will otherwise be @code{NULL}. When @code{define_cond_exec} is used, an implicit reference to the @code{predicable} instruction attribute is made. -@xref{Insn Attributes}. This attribute must be boolean (i.e. have +@xref{Insn Attributes}. This attribute must be boolean (i.e.@: have exactly two elements in its @var{list-of-values}). Further, it must not be used with complex expressions. That is, the default and all uses in the insns must be a simple constant, not dependent on the diff --git a/gcc/doc/tm.texi b/gcc/doc/tm.texi index 880b505e797..57385f8ab36 100644 --- a/gcc/doc/tm.texi +++ b/gcc/doc/tm.texi @@ -3832,7 +3832,7 @@ First, emit code to add the integer @var{delta} to the location that contains the incoming first argument. Assume that this argument contains a pointer, and is the one used to pass the @code{this} pointer in C++. This is the incoming argument @emph{before} the function prologue, -e.g. @samp{%o0} on a sparc. The addition must preserve the values of +e.g.@: @samp{%o0} on a sparc. The addition must preserve the values of all other incoming arguments. After the addition, emit code to jump to @var{function}, which is a @@ -4023,7 +4023,7 @@ assembler code to call function @code{__bb_trace_ret}. The assembler code should only be output if the global compile flag @code{profile_block_flag} == 2. This macro has to be used at every place where code for returning from -a function is generated (e.g. @code{FUNCTION_EPILOGUE}). Although +a function is generated (e.g.@: @code{FUNCTION_EPILOGUE}). Although you have to write the definition of @code{FUNCTION_EPILOGUE} as well, you have to define this macro to tell the compiler, that the proper call to @code{__bb_trace_ret} is produced. @@ -5181,7 +5181,7 @@ ordinarily expect. @findex SLOW_BYTE_ACCESS @item SLOW_BYTE_ACCESS Define this macro as a C expression which is nonzero if accessing less -than a word of memory (i.e. a @code{char} or a @code{short}) is no +than a word of memory (i.e.@: a @code{char} or a @code{short}) is no faster than accessing a word of memory, i.e., if such access require more than one instruction or if there is no difference in cost between byte and (aligned) word loads. @@ -6312,8 +6312,8 @@ the tree nodes are available. @item ASM_OUTPUT_DEFINE_LABEL_DIFFERENCE_SYMBOL (@var{stream}, @var{symbol}, @var{high}, @var{low}) A C statement to output to the stdio stream @var{stream} assembler code which defines (equates) the symbol @var{symbol} to have a value equal to -the difference of the two symbols @var{high} and @var{low}, i.e. -@var{high} minus @var{low}. GCC guarantees that the symbols @var{high} +the difference of the two symbols @var{high} and @var{low}, +i.e.@: @var{high} minus @var{low}. GCC guarantees that the symbols @var{high} and @var{low} are already known by the assembler so that the difference resolves into a constant. @@ -6763,12 +6763,12 @@ or whatever. Don't define this macro if it has nothing to do, but it is helpful in reading assembly output if the extent of the delay sequence is made -explicit (e.g. with white space). +explicit (e.g.@: with white space). @findex final_sequence Note that output routines for instructions with delay slots must be -prepared to deal with not being output as part of a sequence (i.e. -when the scheduling pass is not run, or when no slot fillers could be +prepared to deal with not being output as part of a sequence +(i.e.@: when the scheduling pass is not run, or when no slot fillers could be found.) The variable @code{final_sequence} is null when not processing a sequence, otherwise it contains the @code{sequence} rtx being output. @@ -7754,7 +7754,7 @@ floating point operations, but to perform a single precision operation, the FPSCR PR bit has to be cleared, while for a double precision operation, this bit has to be set. Changing the PR bit requires a general purpose register as a scratch register, hence these FPSCR sets have to -be inserted before reload, i.e. you can't put this into instruction emitting +be inserted before reload, i.e.@: you can't put this into instruction emitting or MACHINE_DEPENDENT_REORG. You can have multiple entities that are mode-switched, and select at run time