aboutsummaryrefslogtreecommitdiff
path: root/gcc/ada/doc/gnat_ugn
diff options
context:
space:
mode:
authorRonan Desplanques <desplanques@adacore.com>2023-04-12 15:01:45 +0200
committerMarc Poulhiès <poulhies@adacore.com>2023-05-30 09:12:16 +0200
commit35875281d9f3f783864f96baf71a279fc657238d (patch)
treef281596622e4734813c4ce3e7e4ed574a11f92e6 /gcc/ada/doc/gnat_ugn
parent2a794b7750cbc9aa8b0c5778cc34b50a72e0f7a0 (diff)
downloadgcc-35875281d9f3f783864f96baf71a279fc657238d.zip
gcc-35875281d9f3f783864f96baf71a279fc657238d.tar.gz
gcc-35875281d9f3f783864f96baf71a279fc657238d.tar.bz2
ada: Fix minor issues in user's guide
gcc/ada/ * doc/gnat_ugn/building_executable_programs_with_gnat.rst: Fix minor issues. * doc/gnat_ugn/the_gnat_compilation_model.rst: Fix minor issues. * gnat_ugn.texi: Regenerate.
Diffstat (limited to 'gcc/ada/doc/gnat_ugn')
-rw-r--r--gcc/ada/doc/gnat_ugn/building_executable_programs_with_gnat.rst32
-rw-r--r--gcc/ada/doc/gnat_ugn/the_gnat_compilation_model.rst2
2 files changed, 16 insertions, 18 deletions
diff --git a/gcc/ada/doc/gnat_ugn/building_executable_programs_with_gnat.rst b/gcc/ada/doc/gnat_ugn/building_executable_programs_with_gnat.rst
index 2838a30..20e003d 100644
--- a/gcc/ada/doc/gnat_ugn/building_executable_programs_with_gnat.rst
+++ b/gcc/ada/doc/gnat_ugn/building_executable_programs_with_gnat.rst
@@ -895,12 +895,12 @@ by ``gnatmake``. It may be necessary to use the switch
Examples of ``gnatmake`` Usage
------------------------------
-*gnatmake hello.adb*
+``gnatmake hello.adb``
Compile all files necessary to bind and link the main program
:file:`hello.adb` (containing unit ``Hello``) and bind and link the
resulting object files to generate an executable file :file:`hello`.
-*gnatmake main1 main2 main3*
+``gnatmake main1 main2 main3``
Compile all files necessary to bind and link the main programs
:file:`main1.adb` (containing unit ``Main1``), :file:`main2.adb`
(containing unit ``Main2``) and :file:`main3.adb`
@@ -908,7 +908,7 @@ Examples of ``gnatmake`` Usage
to generate three executable files :file:`main1`,
:file:`main2` and :file:`main3`.
-*gnatmake -q Main_Unit -cargs -O2 -bargs -l*
+``gnatmake -q Main_Unit -cargs -O2 -bargs -l``
Compile all files necessary to bind and link the main program unit
``Main_Unit`` (from file :file:`main_unit.adb`). All compilations will
be done with optimization level 2 and the order of elaboration will be
@@ -949,7 +949,7 @@ You need *not* compile the following files
* subunits
-because they are compiled as part of compiling related units. GNAT
+because they are compiled as part of compiling related units. GNAT compiles
package specs
when the corresponding body is compiled, and subunits when the parent is
compiled.
@@ -997,8 +997,6 @@ two output files in the current directory, but you may specify a source
file in any directory using an absolute or relative path specification
containing the directory information.
-TESTING: the :switch:`--foobar{NN}` switch
-
.. index:: gnat1
``gcc`` is actually a driver program that looks at the extensions of
@@ -1068,7 +1066,7 @@ directories, in the following order:
* The content of the :file:`ada_source_path` file which is part of the GNAT
installation tree and is used to store standard libraries such as the
GNAT Run Time Library (RTL) source files.
- :ref:`Installing_a_library`
+ See also :ref:`Installing_a_library`.
Specifying the switch :switch:`-I-`
inhibits the use of the directory
@@ -1159,7 +1157,7 @@ Compile body in file :file:`xyz.adb` with all default options.
$ gcc -c -O2 -gnata xyz-def.adb
Compile the child unit package in file :file:`xyz-def.adb` with extensive
-optimizations, and pragma ``Assert``/`Debug` statements
+optimizations, and pragma ``Assert``/``Debug`` statements
enabled.
.. code-block:: sh
@@ -1274,7 +1272,7 @@ Alphabetical List of All Switches
size of the executable, compared with a traditional per-unit compilation
with inlining across units enabled by the :switch:`-gnatn` switch.
The drawback of this approach is that it may require more memory and that
- the debugging information generated by -g with it might be hardly usable.
+ the debugging information generated by ``-g`` with it might be hardly usable.
The switch, as well as the accompanying :switch:`-Ox` switches, must be
specified both for the compilation and the link phases.
If the ``n`` parameter is specified, the optimization and final code
@@ -1472,7 +1470,7 @@ Alphabetical List of All Switches
This switch will generate an intermediate representation suitable for
use by CodePeer (:file:`.scil` files). This switch is not compatible with
code generation (it will, among other things, disable some switches such
- as -gnatn, and enable others such as -gnata).
+ as ``-gnatn``, and enable others such as ``-gnata``).
.. index:: -gnatd (gcc)
@@ -1482,9 +1480,9 @@ Alphabetical List of All Switches
the :switch:`-gnatd` specifies the specific debug options. The possible
characters are 0-9, a-z, A-Z, optionally preceded by a dot or underscore.
See compiler source file :file:`debug.adb` for details of the implemented
- debug options. Certain debug options are relevant to applications
+ debug options. Certain debug options are relevant to application
programmers, and these are documented at appropriate points in this
- users guide.
+ user's guide.
.. index:: -gnatD[nn] (gcc)
@@ -1493,7 +1491,7 @@ Alphabetical List of All Switches
Create expanded source files for source level debugging. This switch
also suppresses generation of cross-reference information
(see :switch:`-gnatx`). Note that this switch is not allowed if a previous
- -gnatR switch has been given, since these two switches are not compatible.
+ ``-gnatR`` switch has been given, since these two switches are not compatible.
.. index:: -gnateA (gcc)
@@ -1638,7 +1636,7 @@ Alphabetical List of All Switches
where implicit ``pragma Elaborate`` and ``pragma Elaborate_All``
are generated. This is useful in diagnosing elaboration circularities
caused by these implicit pragmas when using the static elaboration
- model. See See the section in this guide on elaboration checking for
+ model. See the section in this guide on elaboration checking for
further details. These messages are not generated by default, and are
intended only for temporary use when debugging circularity problems.
@@ -2871,7 +2869,7 @@ of the pragma in the :title:`GNAT_Reference_manual`).
.. index:: -gnatw_A
:switch:`-gnatw_A`
- *Supress warnings on anonymous allocators.*
+ *Suppress warnings on anonymous allocators.*
.. index:: Anonymous allocators
@@ -3011,7 +3009,7 @@ of the pragma in the :title:`GNAT_Reference_manual`).
:switch:`-gnatw_C`
*Suppress warnings on unknown condition in Compile_Time_Warning.*
- This switch supresses warnings on a pragma Compile_Time_Warning
+ This switch suppresses warnings on a pragma Compile_Time_Warning
or Compile_Time_Error whose condition has a value that is not
known at compile time.
@@ -3367,7 +3365,7 @@ of the pragma in the :title:`GNAT_Reference_manual`).
This switch activates warnings for declarations that declare a name that
is defined in package Standard. Such declarations can be confusing,
especially since the names in package Standard continue to be directly
- visible, meaning that use visibiliy on such redeclared names does not
+ visible, meaning that use visibility on such redeclared names does not
work as expected. Names of discriminants and components in records are
not included in this check.
diff --git a/gcc/ada/doc/gnat_ugn/the_gnat_compilation_model.rst b/gcc/ada/doc/gnat_ugn/the_gnat_compilation_model.rst
index 3636703..77a2055 100644
--- a/gcc/ada/doc/gnat_ugn/the_gnat_compilation_model.rst
+++ b/gcc/ada/doc/gnat_ugn/the_gnat_compilation_model.rst
@@ -1974,7 +1974,7 @@ process (see the *Installing a Library with Project Files* section of the
When project files are not an option, it is also possible, but not recommended,
to install the library so that the sources needed to use the library are on the
Ada source path and the ALI files & libraries be on the Ada Object path (see
-:ref:`Search_Paths_and_the_Run-Time_Library_RTL`. Alternatively, the system
+:ref:`Search_Paths_and_the_Run-Time_Library_RTL`). Alternatively, the system
administrator can place general-purpose libraries in the default compiler
paths, by specifying the libraries' location in the configuration files
:file:`ada_source_path` and :file:`ada_object_path`. These configuration files