attributes.7: Comment out 'Preliminary' description

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
This commit is contained in:
Michael Kerrisk 2014-10-18 12:10:41 +02:00
parent 2a089d935c
commit dfe3ffe830
1 changed files with 47 additions and 47 deletions

View File

@ -118,53 +118,53 @@ functions are not safe to call in a multithreaded programs.
.\" .\"
.\" Functions not explicitly documented as safe in a safety context should .\" Functions not explicitly documented as safe in a safety context should
.\" be regarded as Unsafe. .\" be regarded as Unsafe.
.TP .\" .TP
.I Preliminary .\" .I Preliminary
.I Preliminary .\" .I Preliminary
safety properties are documented, indicating these .\" safety properties are documented, indicating these
properties may .\" properties may
.I not .\" .I not
be counted on in future releases of .\" be counted on in future releases of
the GNU C Library. .\" the GNU C Library.
.\"
Such preliminary properties are the result of an assessment of the .\" Such preliminary properties are the result of an assessment of the
properties of our current implementation, .\" properties of our current implementation,
rather than of what is mandated and permitted .\" rather than of what is mandated and permitted
by current and future standards. .\" by current and future standards.
.\"
Although we strive to abide by the standards, in some cases our .\" Although we strive to abide by the standards, in some cases our
implementation is safe even when the standard does not demand safety, .\" implementation is safe even when the standard does not demand safety,
and in other cases our implementation does not meet the standard safety .\" and in other cases our implementation does not meet the standard safety
requirements. .\" requirements.
The latter are most likely bugs; the former, when marked .\" The latter are most likely bugs; the former, when marked
as .\" as
.IR Preliminary , .\" .IR Preliminary ,
should not be counted on: future standards may .\" should not be counted on: future standards may
require changes that are not compatible with the additional safety .\" require changes that are not compatible with the additional safety
properties afforded by the current implementation. .\" properties afforded by the current implementation.
.\"
Furthermore, .\" Furthermore,
the POSIX standard does not offer a detailed definition of safety. .\" the POSIX standard does not offer a detailed definition of safety.
We assume that, by "safe to call", POSIX means that, .\" We assume that, by "safe to call", POSIX means that,
as long as the program does not invoke undefined behavior, .\" as long as the program does not invoke undefined behavior,
the "safe to call" function behaves as specified, .\" the "safe to call" function behaves as specified,
and does not cause other functions to deviate from their specified behavior. .\" and does not cause other functions to deviate from their specified behavior.
We have chosen to use its loose .\" We have chosen to use its loose
definitions of safety, not because they are the best definitions to use, .\" definitions of safety, not because they are the best definitions to use,
but because choosing them harmonizes this manual with POSIX. .\" but because choosing them harmonizes this manual with POSIX.
.\"
Please keep in mind that these are preliminary definitions and annotations, .\" Please keep in mind that these are preliminary definitions and annotations,
and certain aspects of the definitions are still under .\" and certain aspects of the definitions are still under
discussion and might be subject to clarification or change. .\" discussion and might be subject to clarification or change.
.\"
Over time, .\" Over time,
we envision evolving the preliminary safety notes into stable commitments, .\" we envision evolving the preliminary safety notes into stable commitments,
as stable as those of our interfaces. .\" as stable as those of our interfaces.
As we do, we will remove the .\" As we do, we will remove the
.I Preliminary .\" .I Preliminary
keyword from safety notes. .\" keyword from safety notes.
As long as the keyword remains, however, .\" As long as the keyword remains, however,
they are not to be regarded as a promise of future behavior. .\" they are not to be regarded as a promise of future behavior.
.PP .PP
Other keywords that appear in safety notes are defined in subsequent sections. Other keywords that appear in safety notes are defined in subsequent sections.
.\" .\"