attributes.7: Comment out AS-Save and AC-Safe text

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
This commit is contained in:
Michael Kerrisk 2014-10-18 10:49:06 +02:00
parent a6f8ea6a98
commit 6761fb0c02
1 changed files with 45 additions and 45 deletions

View File

@ -61,52 +61,52 @@ The documented
MT-Safety status is not guaranteed under whole-program optimization. MT-Safety status is not guaranteed under whole-program optimization.
However, functions defined in user-visible headers are designed to be However, functions defined in user-visible headers are designed to be
safe for inlining. safe for inlining.
.TP .\" .TP
.I AS-Safe .\" .I AS-Safe
.I AS-Safe .\" .I AS-Safe
or Async-Signal-Safe functions are safe to call from .\" or Async-Signal-Safe functions are safe to call from
asynchronous signal handlers. .\" asynchronous signal handlers.
AS, in AS-Safe, stands for Asynchronous Signal. .\" AS, in AS-Safe, stands for Asynchronous Signal.
.\"
.\" Many functions that are AS-Safe may set
.\" .IR errno ,
.\" or modify the floating-point environment,
.\" because their doing so does not make them
.\" unsuitable for use in signal handlers.
.\" However, programs could misbehave should asynchronous signal handlers
.\" modify this thread-local state,
.\" and the signal handling machinery cannot be counted on to
.\" preserve it.
.\" Therefore, signal handlers that call functions that may set
.\" .I errno
.\" or modify the floating-point environment
.\" .I must
.\" save their original values, and restore them before returning.
.\" .TP
.\" .I AC-Safe
.\" .I AC-Safe
.\" or Async-Cancel-Safe functions are safe to call when
.\" asynchronous cancellation is enabled.
.\" AC in AC-Safe stands for Asynchronous Cancellation.
.\"
.\" The POSIX standard defines only three functions to be AC-Safe, namely
.\" .BR pthread_cancel (3),
.\" .BR pthread_setcancelstate (3),
.\" and
.\" .BR pthread_setcanceltype (3).
.\" At present the GNU C Library provides no
.\" guarantees beyond these three functions,
.\" but does document which functions are presently AC-Safe.
.\" This documentation is provided for use
.\" by the GNU C Library developers.
Many functions that are AS-Safe may set .\" Just like signal handlers, cancellation cleanup routines must configure
.IR errno , .\" the floating point environment they require.
or modify the floating-point environment, .\" The routines cannot assume a floating point environment,
because their doing so does not make them .\" particularly when asynchronous cancellation is enabled.
unsuitable for use in signal handlers. .\" If the configuration of the floating point
However, programs could misbehave should asynchronous signal handlers .\" environment cannot be performed atomically then it is also possible that
modify this thread-local state, .\" the environment encountered is internally inconsistent.
and the signal handling machinery cannot be counted on to
preserve it.
Therefore, signal handlers that call functions that may set
.I errno
or modify the floating-point environment
.I must
save their original values, and restore them before returning.
.TP
.I AC-Safe
.I AC-Safe
or Async-Cancel-Safe functions are safe to call when
asynchronous cancellation is enabled.
AC in AC-Safe stands for Asynchronous Cancellation.
The POSIX standard defines only three functions to be AC-Safe, namely
.BR pthread_cancel (3),
.BR pthread_setcancelstate (3),
and
.BR pthread_setcanceltype (3).
At present the GNU C Library provides no
guarantees beyond these three functions,
but does document which functions are presently AC-Safe.
This documentation is provided for use
by the GNU C Library developers.
Just like signal handlers, cancellation cleanup routines must configure
the floating point environment they require.
The routines cannot assume a floating point environment,
particularly when asynchronous cancellation is enabled.
If the configuration of the floating point
environment cannot be performed atomically then it is also possible that
the environment encountered is internally inconsistent.
.TP .TP
.IR MT-Unsafe ", " AS-Unsafe ", " AC-Unsafe .IR MT-Unsafe ", " AS-Unsafe ", " AC-Unsafe
.IR MT-Unsafe ", " AS-Unsafe ", " AC-Unsafe .IR MT-Unsafe ", " AS-Unsafe ", " AC-Unsafe