re PR ada/15479 (Ada manual problems)

gcc/ada/:
PR documentation/15479
* gnat_ugn.texi: In non-code, avoid space before colon.
(Regular Expressions in gnatfind and gnatxref): Fix indentation.
(Examples of gnatxref Usage): Use @command{vi} instead of
@file{vi}.
(Character Set Control): Do not use @code for UTF-8.
(Validity Checking): Fix typo "NaNs" instead of "NaN's".  Do not
use @code for IEEE.
* gnat_rm.texi (Aggregates with static bounds): Fix typo in code
sample.
* gnat_rm.texi, gnat_ugn.texi: Fix typos.  Bump copyright years.

From-SVN: r132382
This commit is contained in:
Ralf Wildenhues 2008-02-17 21:20:01 +00:00 committed by Ralf Wildenhues
parent 923158bee1
commit e69044cb35
3 changed files with 59 additions and 45 deletions

View File

@ -1,3 +1,17 @@
2008-02-17 Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
PR documentation/15479
* gnat_ugn.texi: In non-code, avoid space before colon.
(Regular Expressions in gnatfind and gnatxref): Fix indentation.
(Examples of gnatxref Usage): Use @command{vi} instead of
@file{vi}.
(Character Set Control): Do not use @code for UTF-8.
(Validity Checking): Fix typo "NaNs" instead of "NaN's". Do not
use @code for IEEE.
* gnat_rm.texi (Aggregates with static bounds): Fix typo in code
sample.
* gnat_rm.texi, gnat_ugn.texi: Fix typos. Bump copyright years.
2008-02-11 Joel Sherrill <joel.sherrill@oarcorp.com>
PR ada/35143

View File

@ -34,7 +34,7 @@
@end direntry
@copying
Copyright @copyright{} 1995-2007, Free Software Foundation
Copyright @copyright{} 1995-2007, 2008 Free Software Foundation
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.2
@ -1745,7 +1745,7 @@ region as the function to which they apply.
pragma applies. If more than one function name exists of this name in
the declarative part you must use the @code{Parameter_Types} and
@code{Result_Type} parameters is mandatory to achieve the required
unique designation. @var{subtype_ mark}s in these parameters must
unique designation. @var{subtype_mark}s in these parameters must
exactly match the subtypes in the corresponding function specification,
using positional notation to match parameters with subtype marks.
The form with an @code{'Access} attribute can be used to match an
@ -3151,7 +3151,7 @@ the compiler as indicating that no body is logically present.
This is particularly useful during maintenance when a package is modified in
such a way that a body needed before is no longer needed. The provision of a
dummy body with a No_Body pragma ensures that there is no inteference from
dummy body with a No_Body pragma ensures that there is no interference from
earlier versions of the package body.
@node Pragma No_Return
@ -7157,7 +7157,7 @@ See separate section on source representation.
length. See 2.2(15).
@end cartouche
@noindent
The maximum line length is 255 characters an the maximum length of a
The maximum line length is 255 characters and the maximum length of a
lexical element is also 255 characters.
@sp 1
@ -7921,7 +7921,7 @@ or by rejecting any construct that would otherwise generate an implicit
@code{for} loop. If this restriction is active, it is possible to build
large array aggregates with all static components without generating an
intermediate temporary, and without generating a loop to initialize individual
components..Otherwise, a loop is created for arrays larger than about 5000
components. Otherwise, a loop is created for arrays larger than about 5000
scalar components.
@item No_Initialize_Scalars
@ -8355,7 +8355,7 @@ pragma Linker_Options ("-labc" & ASCII.Nul & "-ldef");
causes two separate arguments @code{-labc} and @code{-ldef} to be passed to the
linker. The order of linker options is preserved for a given unit. The final
list of options passed to the linker is in reverse order of the elaboration
order. For example, linker options fo a body always appear before the options
order. For example, linker options for a body always appear before the options
from the corresponding package spec.
@sp 1
@ -13360,7 +13360,7 @@ for hexadecimal literals.
@cindex @code{GNAT.Decode_String} (@file{g-decstr.ads})
@cindex Decoding strings
@cindex String decoding
@cindex Wide chararacter encoding
@cindex Wide character encoding
@cindex UTF-8
@cindex Unicode
@ -13370,7 +13370,7 @@ character strings encoded as sequences of 8-bit characters using a specified
encoding method. Includes validation routines, and also routines for stepping
to next or previous encoded character in an encoded string.
Useful in conjunction with Unicode character coding. Note there is a
preinstiation for UTF-8. See next entry.
preinstantiation for UTF-8. See next entry.
@node GNAT.Decode_UTF8_String (g-deutst.ads)
@section @code{GNAT.Decode_UTF8_String} (@file{g-deutst.ads})
@ -13378,12 +13378,12 @@ preinstiation for UTF-8. See next entry.
@cindex Decoding strings
@cindex Decoding UTF-8 strings
@cindex UTF-8 string decoding
@cindex Wide chararacter decoding
@cindex Wide character decoding
@cindex UTF-8
@cindex Unicode
@noindent
A preinstantion of GNAT.Decode_Strings for UTF-8 encoding.
A preinstantiation of GNAT.Decode_Strings for UTF-8 encoding.
@node GNAT.Directory_Operations (g-dirope.ads)
@section @code{GNAT.Directory_Operations} (@file{g-dirope.ads})
@ -13441,7 +13441,7 @@ dynamic instances of the table, while an instantiation of
@cindex @code{GNAT.Encode_String} (@file{g-encstr.ads})
@cindex Encoding strings
@cindex String encoding
@cindex Wide chararacter encoding
@cindex Wide character encoding
@cindex UTF-8
@cindex Unicode
@ -13449,7 +13449,7 @@ dynamic instances of the table, while an instantiation of
A generic package providing routines for encoding wide character and wide
wide character strings as sequences of 8-bit characters using a specified
encoding method. Useful in conjunction with Unicode character coding.
Note there is a preinstiation for UTF-8. See next entry.
Note there is a preinstantiation for UTF-8. See next entry.
@node GNAT.Encode_UTF8_String (g-enutst.ads)
@section @code{GNAT.Encode_UTF8_String} (@file{g-enutst.ads})
@ -13457,12 +13457,12 @@ Note there is a preinstiation for UTF-8. See next entry.
@cindex Encoding strings
@cindex Encoding UTF-8 strings
@cindex UTF-8 string encoding
@cindex Wide chararacter encoding
@cindex Wide character encoding
@cindex UTF-8
@cindex Unicode
@noindent
A preinstantion of GNAT.Encode_Strings for UTF-8 encoding.
A preinstantiation of GNAT.Encode_Strings for UTF-8 encoding.
@node GNAT.Exception_Actions (g-excact.ads)
@section @code{GNAT.Exception_Actions} (@file{g-excact.ads})
@ -14876,7 +14876,7 @@ generate the equivalent of
Cr_Var1 (4) := 11;
for I in Cr_Var2'range loop
Cr_Var2 (I) := =-1;
Cr_Var2 (I) := -1;
end loop;
@end smallexample

View File

@ -117,7 +117,7 @@
@c %**end of header
@copying
Copyright @copyright{} 1995-2005, Free Software Foundation
Copyright @copyright{} 1995-2005, 2006, 2007, 2008 Free Software Foundation
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.2
@ -5041,7 +5041,7 @@ This switch activates warnings for variables that are modified by using
them as actuals for a call to a procedure with an out mode formal, where
the resulting assigned value is never read. It is applicable in the case
where there is more than one out mode formal. If there is only one out
mode formal, the waraning is issued by default (controlled by -gnatwu).
mode formal, the warning is issued by default (controlled by -gnatwu).
The warning is suppressed for volatile
variables and also for variables that are renamings of other variables
or for which an address clause is given.
@ -5506,9 +5506,9 @@ are assigned component by component.
@cindex @option{-gnatVf} (@command{gcc})
In the absence of this switch, validity checking occurs only for discrete
values. If @option{-gnatVf} is specified, then validity checking also applies
for floating-point values, and NaN's and infinities are considered invalid,
for floating-point values, and NaNs and infinities are considered invalid,
as well as out of range values for constrained types. Note that this means
that standard @code{IEEE} infinity mode is not allowed. The exact contexts
that standard IEEE infinity mode is not allowed. The exact contexts
in which floating-point values are checked depends on the setting of other
options. For example,
@option{^-gnatVif^VALIDITY_CHECKING=(IN_PARAMS,FLOATS)^} or
@ -6456,7 +6456,7 @@ For full details on these encoding
methods see @ref{Wide Character Encodings}.
Note that brackets coding is always accepted, even if one of the other
options is specified, so for example @option{-gnatW8} specifies that both
brackets and @code{UTF-8} encodings will be recognized. The units that are
brackets and UTF-8 encodings will be recognized. The units that are
with'ed directly or indirectly will be scanned using the specified
representation scheme, and so if one of the non-brackets scheme is
used, it must be used consistently throughout the program. However,
@ -9175,7 +9175,7 @@ $ gnatmake /SOURCE_SEARCH=@i{[INCLUDE_DIR]}
@item
Using @command{gnatmake} along with the
@option{^-m (minimal recompilation)^/MINIMAL_RECOMPILATION^}
switch provides a mechanism for avoiding unnecessary rcompilations. Using
switch provides a mechanism for avoiding unnecessary recompilations. Using
this switch,
you can update the comments/format of your
source files without having to recompile everything. Note, however, that
@ -11943,7 +11943,7 @@ reserved words currently used in project file syntax are:
@end itemize
@noindent
Comments in project files have the same syntax as in Ada, two consecutives
Comments in project files have the same syntax as in Ada, two consecutive
hyphens through the end of the line.
@node Packages
@ -14619,7 +14619,7 @@ the source path. If you specify directories, no result is produced.
@end table
@noindent
The switches can be :
The switches can be:
@table @option
@c !sort!
@item --version
@ -15005,14 +15005,14 @@ specifies the command used to debug the application
@noindent
As specified in the section about @command{gnatfind}, the pattern can be a
regular expression. Actually, there are to set of regular expressions
which are recognized by the program :
which are recognized by the program:
@table @code
@item globbing patterns
These are the most usual regular expression. They are the same that you
generally used in a Unix shell command line, or in a DOS session.
Here is a more formal grammar :
Here is a more formal grammar:
@smallexample
@group
@iftex
@ -15023,7 +15023,7 @@ term ::= elmt -- matches elmt
term ::= elmt elmt -- concatenation (elmt then elmt)
term ::= * -- any string of 0 or more characters
term ::= ? -- matches any character
term ::= [char @{char@}] -- matches any character listed
term ::= [char @{char@}] -- matches any character listed
term ::= [char - char] -- matches any character in range
@end group
@end smallexample
@ -15040,9 +15040,9 @@ reference manual style BNF is as follows
@leftskip=.5cm
@end iftex
@group
regexp ::= term @{| term@} -- alternation (term or term ...)
regexp ::= term @{| term@} -- alternation (term or term ...)
term ::= item @{item@} -- concatenation (item then item)
term ::= item @{item@} -- concatenation (item then item)
item ::= elmt -- match elmt
item ::= elmt * -- zero or more elmt's
@ -15063,7 +15063,7 @@ nschar ::= any character except ()[].*+?^^^
@end group
@end smallexample
Following are a few examples :
Following are a few examples:
@table @samp
@item abcde|fghi
@ -15074,7 +15074,7 @@ will match any string like 'abd', 'abcd', 'abccd', 'abcccd', and so on
@item [a-z]+
will match any string which has only lowercase characters in it (and at
least one character
least one character.
@end table
@end table
@ -15085,7 +15085,7 @@ least one character
@subsection General Usage
@noindent
For the following examples, we will consider the following units :
For the following examples, we will consider the following units:
@smallexample @c ada
@group
@ -15181,9 +15181,9 @@ of these.
@subsection Using gnatxref with vi
@code{gnatxref} can generate a tags file output, which can be used
directly from @file{vi}. Note that the standard version of @file{vi}
directly from @command{vi}. Note that the standard version of @command{vi}
will not work properly with overloaded symbols. Consider using another
free implementation of @file{vi}, such as @file{vim}.
free implementation of @command{vi}, such as @command{vim}.
@smallexample
$ gnatxref -v gnatfind.adb > tags
@ -15193,7 +15193,7 @@ $ gnatxref -v gnatfind.adb > tags
will generate the tags file for @code{gnatfind} itself (if the sources
are in the search path!).
From @file{vi}, you can then use the command @samp{:tag @i{entity}}
From @command{vi}, you can then use the command @samp{:tag @i{entity}}
(replacing @i{entity} by whatever you are looking for), and vi will
display a new file with the corresponding declaration of entity.
@end ifclear
@ -15581,7 +15581,7 @@ keyword @code{then} in IF statements on a separate line.
@cindex @option{^--no-separate-loop-then^/NO_SEPARATE_LOOP_THEN^} (@command{gnatpp})
@item ^--no-separate-loop-then^/NO_SEPARATE_LOOP_THEN^
Do not place the keyword @code{loop} in FOR and WHILE loop statements and the
keyw0rd @code{then} in IF statements on a separate line. This option is
keyword @code{then} in IF statements on a separate line. This option is
incompatible with @option{^--separate-loop-then^/SEPARATE_LOOP_THEN^} option.
@cindex @option{^--use-on-new-line^/USE_ON_NEW_LINE^} (@command{gnatpp})
@ -16027,7 +16027,7 @@ many words in a line as possible).
@noindent
The @option{^-c5^/COMMENTS_LAYOUT=KEEP_SPECIAL^} switch specifies, that comments
that has a special format (that is, a character that is neither a letter nor digit
not white space nor line break immediatelly following the leading @code{--} of
not white space nor line break immediately following the leading @code{--} of
the comment) should be without any change moved from the argument source
into reformatted source. This switch allows to preserve comments that are used
as a special marks in the code (e.g. SPARK annotation).
@ -18721,7 +18721,7 @@ GLIB=...
# The directories for the libraries
# (This macro expands the list of CSC to the list of shared libraries, you
# could simply use the expanded form :
# could simply use the expanded form:
# LIB_DIR=aa/lib/libaa.so bb/lib/libbb.so cc/lib/libcc.so
LIB_DIR=$@{foreach dir,$@{CSC_LIST@},$@{dir@}/lib/lib$@{dir@}.so@}
@ -20289,7 +20289,7 @@ All forms for specifying a range (explicit ranges
such as @code{A .. B}, subtype marks and @code{'Range} attributes) are flagged.
An enumeration range is
flagged even if contains exactly one enumeration value or no values at all. A
type derived fom an enumeration type is considered as an enumeration type.
type derived from an enumeration type is considered as an enumeration type.
This rule helps prevent maintenance problems arising from adding an
enumeration value to a type and having it implicitly handled by an existing
@ -20303,7 +20303,7 @@ This rule has no parameters.
@cindex @code{Exceptions_As_Control_Flow} (for @command{gnatcheck})
@noindent
Flag each place where an exception is explictly raised and handled in the
Flag each place where an exception is explicitly raised and handled in the
same subprogram body. A @code{raise} statement in an exception handler,
package body, task body or entry body is not flagged.
@ -20434,13 +20434,13 @@ affect the set of pragmas to be detected.
Flag each procedure that can be rewritten as a function. A procedure can be
converted into a function if it has exactly one parameter of mode @code{out}
and no parameters of mode @code{in out}. Procedure declarations,
formal procedure declarations. and generic procedure declarations are always
formal procedure declarations, and generic procedure declarations are always
checked. Procedure
bodies and body stubs are flagged only if they do not have corresponding
separate declarations. Procedure renamings and procedure instantiations are
not flagged.
If a procedure can be rewritten as a fucntion, but its @code{out} parameter is
If a procedure can be rewritten as a function, but its @code{out} parameter is
of a limited type, it is not flagged.
Protected procedures are not flagged. Null procedures also are not flagged.
@ -20453,7 +20453,7 @@ This rule has no parameters.
@cindex @code{Generics_In_Subprograms} rule (for @command{gnatcheck})
@noindent
Flag each declaration of a generic unit in a supbrogram. Generic
Flag each declaration of a generic unit in a subprogram. Generic
declarations in the bodies of generic subprograms are also flagged.
A generic unit nested in another generic unit is not flagged.
If a generic unit is
@ -21749,7 +21749,7 @@ You can pass it as many Ada files as you want. @code{gnathtml} will generate
an html file for every ada file, and a global file called @file{index.htm}.
This file is an index of every identifier defined in the files.
The available ^switches^options^ are the following ones :
The available ^switches^options^ are the following ones:
@table @option
@item -83
@ -21838,7 +21838,7 @@ Operating System via the Internet.
On Unix systems, you may want to modify the first line of the script
@code{gnathtml}, to explicitly tell the Operating system where Perl
is. The syntax of this line is :
is. The syntax of this line is:
@smallexample
#!full_path_name_to_perl
@end smallexample
@ -27965,7 +27965,7 @@ For Body ("File_Queries.Insert") use "file_queries-insert-2005.ada";
@noindent
Note also that with project files it is desirable to use a different extension
than @file{ads} / @file{adb} for alternativee versions. Otherwise a naming
than @file{ads} / @file{adb} for alternative versions. Otherwise a naming
conflict may arise through another commonly used feature: to declare as part
of the project a set of directories containing all the sources obeying the
default naming scheme.