From: Tonu Naks <n...@adacore.com> gcc/ada/
* doc/gnat_rm/implementation_defined_pragmas.rst: Add examples. * gnat_rm.texi: Regenerate. * gnat_ugn.texi: Regenerate. Tested on x86_64-pc-linux-gnu, committed on master. --- .../implementation_defined_pragmas.rst | 79 +++++++++++++++++-- gcc/ada/gnat_rm.texi | 77 +++++++++++++++++- gcc/ada/gnat_ugn.texi | 2 +- 3 files changed, 150 insertions(+), 8 deletions(-) diff --git a/gcc/ada/doc/gnat_rm/implementation_defined_pragmas.rst b/gcc/ada/doc/gnat_rm/implementation_defined_pragmas.rst index 926c5f4e37b..7ff94c4c2b9 100644 --- a/gcc/ada/doc/gnat_rm/implementation_defined_pragmas.rst +++ b/gcc/ada/doc/gnat_rm/implementation_defined_pragmas.rst @@ -6328,21 +6328,91 @@ activated. These are additive, so they apply in addition to any previously set style check options. The codes for the options are the same as those used in the *-gnaty* switch to *gcc* or *gnatmake*. For example the following two methods can be used to enable -layout checking: +layout checking and to change the maximum nesting level value: * - :: + .. code-block:: ada + -- switch on layout checks pragma Style_Checks ("l"); - + -- set the number of maximum allowed nesting levels to 15 + pragma Style_Checks ("L15"); * :: - gcc -c -gnatyl ... + gcc -c -gnatyl -gnatyL15 ... + + +The string literal values can be cumulatively switched on and off by prefixing +the value with ``+`` or ``-``, where: + +* ``+`` is equivalent to no prefix. It applies the check referenced by the + literal value; +* ``-`` switches the referenced check off. + + +.. code-block:: ada + :linenos: + :emphasize-lines: 15 + + -- allow misaligned block by disabling layout check + pragma Style_Checks ("-l"); + declare + msg : constant String := "Hello"; + begin + Put_Line (msg); + end; + + -- enable the layout check again + pragma Style_Checks ("l"); + declare + msg : constant String := "Hello"; + begin + Put_Line (msg); + end; + +The code above contains two layout errors, however, only +the last line is picked up by the compiler. + +Similarly, the switches containing a numeric value can be applied in sequence. +In the example below, the permitted nesting level is reduced in in the middle +block and the compiler raises a warning on the highlighted line. +.. code-block:: ada + :linenos: + :emphasize-lines: 15 + + -- Permit 3 levels of nesting + pragma Style_Checks ("L3"); + + procedure Main is + begin + if True then + if True then + null; + end if; + end if; + -- Reduce permitted nesting levels to 2. + -- Note that "+L2" and "L2" are equivalent. + pragma Style_Checks ("+L2"); + if True then + if True then + null; + end if; + end if; + -- Disable checking permitted nesting levels. + -- Note that the number after "-L" is insignificant, + -- "-L", "-L3" and "-Lx" are all equivalent. + pragma Style_Checks ("-L3"); + if True then + if True then + null; + end if; + end if; + end Main; The form ``ALL_CHECKS`` activates all standard checks (its use is equivalent to the use of the :switch:`gnaty` switch with no options. @@ -6356,7 +6426,6 @@ The forms with ``Off`` and ``On`` can be used to temporarily disable style checks as shown in the following example: - .. code-block:: ada pragma Style_Checks ("k"); -- requires keywords in lower case diff --git a/gcc/ada/gnat_rm.texi b/gcc/ada/gnat_rm.texi index d5e8931e088..3a766ccc38d 100644 --- a/gcc/ada/gnat_rm.texi +++ b/gcc/ada/gnat_rm.texi @@ -7901,22 +7901,95 @@ activated. These are additive, so they apply in addition to any previously set style check options. The codes for the options are the same as those used in the `-gnaty' switch to `gcc' or `gnatmake'. For example the following two methods can be used to enable -layout checking: +layout checking and to change the maximum nesting level value: @itemize * @item @example +-- switch on layout checks pragma Style_Checks ("l"); +-- set the number of maximum allowed nesting levels to 15 +pragma Style_Checks ("L15"); @end example @item @example -gcc -c -gnatyl ... +gcc -c -gnatyl -gnatyL15 ... @end example @end itemize +The string literal values can be cumulatively switched on and off by prefixing +the value with @code{+} or @code{-}, where: + + +@itemize * + +@item +@code{+} is equivalent to no prefix. It applies the check referenced by the +literal value; + +@item +@code{-} switches the referenced check off. +@end itemize + +@example +-- allow misaligned block by disabling layout check +pragma Style_Checks ("-l"); +declare + msg : constant String := "Hello"; +begin + Put_Line (msg); + end; + +-- enable the layout check again +pragma Style_Checks ("l"); +declare + msg : constant String := "Hello"; +begin + Put_Line (msg); + end; +@end example + +The code above contains two layout errors, however, only +the last line is picked up by the compiler. + +Similarly, the switches containing a numeric value can be applied in sequence. +In the example below, the permitted nesting level is reduced in in the middle +block and the compiler raises a warning on the highlighted line. + +@example +-- Permit 3 levels of nesting +pragma Style_Checks ("L3"); + +procedure Main is +begin + if True then + if True then + null; + end if; + end if; + -- Reduce permitted nesting levels to 2. + -- Note that "+L2" and "L2" are equivalent. + pragma Style_Checks ("+L2"); + if True then + if True then + null; + end if; + end if; + -- Disable checking permitted nesting levels. + -- Note that the number after "-L" is insignificant, + -- "-L", "-L3" and "-Lx" are all equivalent. + pragma Style_Checks ("-L3"); + if True then + if True then + null; + end if; + end if; +end Main; +@end example + The form @code{ALL_CHECKS} activates all standard checks (its use is equivalent to the use of the @code{gnaty} switch with no options. See the @cite{GNAT User’s Guide} for details.) diff --git a/gcc/ada/gnat_ugn.texi b/gcc/ada/gnat_ugn.texi index ea1d2f9d71a..0e3ee935552 100644 --- a/gcc/ada/gnat_ugn.texi +++ b/gcc/ada/gnat_ugn.texi @@ -29670,8 +29670,8 @@ to permit their use in free software. @printindex ge -@anchor{gnat_ugn/gnat_utility_programs switches-related-to-project-files}@w{ } @anchor{d1}@w{ } +@anchor{gnat_ugn/gnat_utility_programs switches-related-to-project-files}@w{ } @c %**end of body @bye -- 2.45.2