[PATCH] manual: New signal and errno string functions are AS-safe

classic Classic list List threaded Threaded
2 messages Options
Reply | Threaded
Open this post in threaded view
|

[PATCH] manual: New signal and errno string functions are AS-safe

Sourceware - libc-alpha mailing list
The annotations for sigabbrev_np, sigdescr_np, strerrordesc_np,
strerrorname_np are not preliminary.  These functions were
added precisely because they are AS-safe.

---
 manual/errno.texi  | 4 ++--
 manual/signal.texi | 4 ++--
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/manual/errno.texi b/manual/errno.texi
index 1834339220..6ca566522d 100644
--- a/manual/errno.texi
+++ b/manual/errno.texi
@@ -1209,7 +1209,7 @@ The function @code{perror} is declared in @file{stdio.h}.
 
 @deftypefun void strerrorname_np (int @var{errnum})
 @standards{GNU, string.h}
-@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
+@safety{@mtsafe{}@assafe{}@acsafe{}}
 This function returns the name describing the error @var{errnum} or
 @code{NULL} if there is no known constant with this value (e.g "EINVAL"
 for @code{EINVAL}).
@@ -1220,7 +1220,7 @@ This function is a GNU extension, declared in the header file @file{string.h}.
 
 @deftypefun void strerrordesc_np (int @var{errnum})
 @standards{GNU, string.h}
-@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
+@safety{@mtsafe{}@assafe{}@acsafe{}}
 This function returns the message describing the error @var{errnum} or
 @code{NULL} if there is no known constant with this value (e.g "Invalid
 argument" for @code{EINVAL}).  Different than @code{strerror} the returned
diff --git a/manual/signal.texi b/manual/signal.texi
index 4009ff48a4..c300a3c9df 100644
--- a/manual/signal.texi
+++ b/manual/signal.texi
@@ -882,7 +882,7 @@ This function is a BSD feature, declared in the header file @file{signal.h}.
 
 @deftypefun void sigdescr_np (int @var{signum})
 @standards{GNU, string.h}
-@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
+@safety{@mtsafe{}@assafe{}@acsafe{}}
 This function returns the message describing the signal @var{signum} or
 @code{NULL} for invalid signal number (e.g "Hangup" for @code{SIGHUP}).
 Different than @code{strsignal} the returned description is not translated.
@@ -895,7 +895,7 @@ This function is a GNU extension, declared in the header file @file{string.h}.
 
 @deftypefun void sigabbrev_np (int @var{signum})
 @standards{GNU, string.h}
-@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
+@safety{@mtsafe{}@assafe{}@acsafe{}}
 This function returns the abbreviation describing the signal @var{signum} or
 @code{NULL} for invalid signal number.  The message points to a static
 storage whose lifetime is the whole lifetime of the program.

Reply | Threaded
Open this post in threaded view
|

Re: [PATCH] manual: New signal and errno string functions are AS-safe

Sourceware - libc-alpha mailing list
On 7/17/20 7:36 AM, Florian Weimer via Libc-alpha wrote:
> The annotations for sigabbrev_np, sigdescr_np, strerrordesc_np,
> strerrorname_np are not preliminary.  These functions were
> added precisely because they are AS-safe.

Completely agreed. Thank you for being the first person to review
and alter safety markup to match our contract with developers.

OK for 2.32.

Reviewed-by: Carlos O'Donell <[hidden email]>
 

> ---
>  manual/errno.texi  | 4 ++--
>  manual/signal.texi | 4 ++--
>  2 files changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/manual/errno.texi b/manual/errno.texi
> index 1834339220..6ca566522d 100644
> --- a/manual/errno.texi
> +++ b/manual/errno.texi
> @@ -1209,7 +1209,7 @@ The function @code{perror} is declared in @file{stdio.h}.
>  
>  @deftypefun void strerrorname_np (int @var{errnum})
>  @standards{GNU, string.h}
> -@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
> +@safety{@mtsafe{}@assafe{}@acsafe{}}

OK.

>  This function returns the name describing the error @var{errnum} or
>  @code{NULL} if there is no known constant with this value (e.g "EINVAL"
>  for @code{EINVAL}).
> @@ -1220,7 +1220,7 @@ This function is a GNU extension, declared in the header file @file{string.h}.
>  
>  @deftypefun void strerrordesc_np (int @var{errnum})
>  @standards{GNU, string.h}
> -@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
> +@safety{@mtsafe{}@assafe{}@acsafe{}}

OK.

>  This function returns the message describing the error @var{errnum} or
>  @code{NULL} if there is no known constant with this value (e.g "Invalid
>  argument" for @code{EINVAL}).  Different than @code{strerror} the returned
> diff --git a/manual/signal.texi b/manual/signal.texi
> index 4009ff48a4..c300a3c9df 100644
> --- a/manual/signal.texi
> +++ b/manual/signal.texi
> @@ -882,7 +882,7 @@ This function is a BSD feature, declared in the header file @file{signal.h}.
>  
>  @deftypefun void sigdescr_np (int @var{signum})
>  @standards{GNU, string.h}
> -@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
> +@safety{@mtsafe{}@assafe{}@acsafe{}}
>  This function returns the message describing the signal @var{signum} or
>  @code{NULL} for invalid signal number (e.g "Hangup" for @code{SIGHUP}).
>  Different than @code{strsignal} the returned description is not translated.
> @@ -895,7 +895,7 @@ This function is a GNU extension, declared in the header file @file{string.h}.
>  
>  @deftypefun void sigabbrev_np (int @var{signum})
>  @standards{GNU, string.h}
> -@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
> +@safety{@mtsafe{}@assafe{}@acsafe{}}
>  This function returns the abbreviation describing the signal @var{signum} or
>  @code{NULL} for invalid signal number.  The message points to a static
>  storage whose lifetime is the whole lifetime of the program.
>


--
Cheers,
Carlos.