diff options
author | Arnaud Charlet <charlet@adacore.com> | 2020-08-28 04:46:52 -0400 |
---|---|---|
committer | Pierre-Marie de Rodat <derodat@adacore.com> | 2020-10-23 04:24:53 -0400 |
commit | 99d4c1b09bb902c59e9cdec56a09d3e7761b0d00 (patch) | |
tree | 455fc22ec179934ed2c762c9297f9a9864985e03 | |
parent | 6cc203bf2a78be88d60fd250617e0c652451b8aa (diff) | |
download | gcc-99d4c1b09bb902c59e9cdec56a09d3e7761b0d00.zip gcc-99d4c1b09bb902c59e9cdec56a09d3e7761b0d00.tar.gz gcc-99d4c1b09bb902c59e9cdec56a09d3e7761b0d00.tar.bz2 |
[Ada] Improve documentation of pragma Abort_Defer
gcc/ada/
* doc/gnat_rm/implementation_defined_pragmas.rst: Improve
documentation of pragma Abort_Defer.
* gnat_rm.texi: Regenerate.
-rw-r--r-- | gcc/ada/doc/gnat_rm/implementation_defined_pragmas.rst | 16 | ||||
-rw-r--r-- | gcc/ada/gnat_rm.texi | 16 |
2 files changed, 30 insertions, 2 deletions
diff --git a/gcc/ada/doc/gnat_rm/implementation_defined_pragmas.rst b/gcc/ada/doc/gnat_rm/implementation_defined_pragmas.rst index af313c1..a5aff66 100644 --- a/gcc/ada/doc/gnat_rm/implementation_defined_pragmas.rst +++ b/gcc/ada/doc/gnat_rm/implementation_defined_pragmas.rst @@ -37,7 +37,21 @@ This pragma must appear at the start of the statement sequence of a handled sequence of statements (right after the ``begin``). It has the effect of deferring aborts for the sequence of statements (but not for the declarations or handlers, if any, associated with this statement -sequence). +sequence). This can also be useful for adding a polling point in Ada code, +where asynchronous abort of tasks is checked when leaving the statement +sequence, and is lighter than, for example, using ``delay 0.0;``, since with +zero-cost exception handling, propagating exceptions (implicitly used to +implement task abort) cannot be done reliably in an asynchronous way. + +An example of usage would be: + +.. code-block:: ada + + -- Add a polling point to check for task aborts + + begin + pragma Abort_Defer; + end; .. _Pragma-Abstract_State: diff --git a/gcc/ada/gnat_rm.texi b/gcc/ada/gnat_rm.texi index af8bd07..d4016aa 100644 --- a/gcc/ada/gnat_rm.texi +++ b/gcc/ada/gnat_rm.texi @@ -1394,7 +1394,21 @@ This pragma must appear at the start of the statement sequence of a handled sequence of statements (right after the @code{begin}). It has the effect of deferring aborts for the sequence of statements (but not for the declarations or handlers, if any, associated with this statement -sequence). +sequence). This can also be useful for adding a polling point in Ada code, +where asynchronous abort of tasks is checked when leaving the statement +sequence, and is lighter than, for example, using @code{delay 0.0;}, since with +zero-cost exception handling, propagating exceptions (implicitly used to +implement task abort) cannot be done reliably in an asynchronous way. + +An example of usage would be: + +@example +-- Add a polling point to check for task aborts + +begin + pragma Abort_Defer; +end; +@end example @node Pragma Abstract_State,Pragma Ada_83,Pragma Abort_Defer,Implementation Defined Pragmas @anchor{gnat_rm/implementation_defined_pragmas pragma-abstract-state}@anchor{1c}@anchor{gnat_rm/implementation_defined_pragmas id2}@anchor{1d} |