aboutsummaryrefslogtreecommitdiff
path: root/gcc
diff options
context:
space:
mode:
authorAlexandre Oliva <oliva@adacore.com>2022-07-07 08:55:24 -0300
committerPierre-Marie de Rodat <derodat@adacore.com>2022-07-13 10:01:17 +0000
commit4621bae835be11ae4ec81d5842166e819826459c (patch)
tree6d3cee303c0447ff772598b98006cf12da2056c2 /gcc
parent8e3030ea9ae79880850c821887c9aa06a76ac21b (diff)
downloadgcc-4621bae835be11ae4ec81d5842166e819826459c.zip
gcc-4621bae835be11ae4ec81d5842166e819826459c.tar.gz
gcc-4621bae835be11ae4ec81d5842166e819826459c.tar.bz2
[Ada] Clarify hardening command-line options that require explicit choices
Prefixes -fzero-call-used-regs and -fstrub could be mistaken for full command-line options with the references to them in the GNAT RM. Make it clearer that they require explicit choices. gcc/ada/ * doc/gnat_rm/security_hardening_features.rst: Clarify the need for choices after -fzero-call-used-regs and -fstrub. * gnat_rm.texi: Regenerate.
Diffstat (limited to 'gcc')
-rw-r--r--gcc/ada/doc/gnat_rm/security_hardening_features.rst17
-rw-r--r--gcc/ada/gnat_rm.texi17
2 files changed, 18 insertions, 16 deletions
diff --git a/gcc/ada/doc/gnat_rm/security_hardening_features.rst b/gcc/ada/doc/gnat_rm/security_hardening_features.rst
index f4f752d..f5fdc8e 100644
--- a/gcc/ada/doc/gnat_rm/security_hardening_features.rst
+++ b/gcc/ada/doc/gnat_rm/security_hardening_features.rst
@@ -18,9 +18,10 @@ Register Scrubbing
GNAT can generate code to zero-out hardware registers before returning
from a subprogram.
-It can be enabled with the :switch:`-fzero-call-used-regs` command-line
-option, to affect all subprograms in a compilation, and with a
-:samp:`Machine_Attribute` pragma, to affect only specific subprograms.
+It can be enabled with the :switch:`-fzero-call-used-regs={choice}`
+command-line option, to affect all subprograms in a compilation, and
+with a :samp:`Machine_Attribute` pragma, to affect only specific
+subprograms.
.. code-block:: ada
@@ -73,11 +74,11 @@ or a variable.)
-- scrubbing of the stack space used by that subprogram.
-There are also :switch:`-fstrub` command-line options to control
-default settings. For usage and more details on the command-line
-option, on the ``strub`` attribute, and their use with other
-programming languages, see :title:`Using the GNU Compiler Collection
-(GCC)`.
+There are also :switch:`-fstrub={choice}` command-line options to
+control default settings. For usage and more details on the
+command-line options, on the ``strub`` attribute, and their use with
+other programming languages, see :title:`Using the GNU Compiler
+Collection (GCC)`.
Note that Ada secondary stacks are not scrubbed. The restriction
``No_Secondary_Stack`` avoids their use, and thus their accidental
diff --git a/gcc/ada/gnat_rm.texi b/gcc/ada/gnat_rm.texi
index b264a45..1ffc146 100644
--- a/gcc/ada/gnat_rm.texi
+++ b/gcc/ada/gnat_rm.texi
@@ -21,7 +21,7 @@
@copying
@quotation
-GNAT Reference Manual , Jun 24, 2022
+GNAT Reference Manual , Jul 11, 2022
AdaCore
@@ -28922,9 +28922,10 @@ change.
GNAT can generate code to zero-out hardware registers before returning
from a subprogram.
-It can be enabled with the @code{-fzero-call-used-regs} command-line
-option, to affect all subprograms in a compilation, and with a
-@code{Machine_Attribute} pragma, to affect only specific subprograms.
+It can be enabled with the @code{-fzero-call-used-regs=@emph{choice}}
+command-line option, to affect all subprograms in a compilation, and
+with a @code{Machine_Attribute} pragma, to affect only specific
+subprograms.
@example
procedure Foo;
@@ -28975,10 +28976,10 @@ pragma Machine_Attribute (Var, "strub");
-- scrubbing of the stack space used by that subprogram.
@end example
-There are also @code{-fstrub} command-line options to control
-default settings. For usage and more details on the command-line
-option, on the @code{strub} attribute, and their use with other
-programming languages, see @cite{Using the GNU Compiler Collection (GCC)}.
+There are also @code{-fstrub=@emph{choice}} command-line options to
+control default settings. For usage and more details on the
+command-line options, on the @code{strub} attribute, and their use with
+other programming languages, see @cite{Using the GNU Compiler Collection (GCC)}.
Note that Ada secondary stacks are not scrubbed. The restriction
@code{No_Secondary_Stack} avoids their use, and thus their accidental