diff mbox series

[COMMITTED] manual: Fix strerrorname_np and strerrordesc_np return type (BZ #26343)

Message ID 20200807195230.3312135-1-adhemerval.zanella@linaro.org
State New
Headers show
Series [COMMITTED] manual: Fix strerrorname_np and strerrordesc_np return type (BZ #26343) | expand

Commit Message

Adhemerval Zanella Aug. 7, 2020, 7:52 p.m. UTC
---
 manual/errno.texi | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Florian Weimer Aug. 7, 2020, 8:04 p.m. UTC | #1
* Adhemerval Zanella via Libc-alpha:

> ---
>  manual/errno.texi | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/manual/errno.texi b/manual/errno.texi
> index 6ca566522d..7ac1554bb1 100644
> --- a/manual/errno.texi
> +++ b/manual/errno.texi
> @@ -1207,7 +1207,7 @@ to @code{errno}.
>  The function @code{perror} is declared in @file{stdio.h}.
>  @end deftypefun
>  
> -@deftypefun void strerrorname_np (int @var{errnum})
> +@deftypefun const char * strerrorname_np (int @var{errnum})
>  @standards{GNU, string.h}
>  @safety{@mtsafe{}@assafe{}@acsafe{}}
>  This function returns the name describing the error @var{errnum} or
> @@ -1218,7 +1218,7 @@ for @code{EINVAL}).
>  This function is a GNU extension, declared in the header file @file{string.h}.
>  @end deftypefun
>  
> -@deftypefun void strerrordesc_np (int @var{errnum})
> +@deftypefun const char * strerrordesc_np (int @var{errnum})
>  @standards{GNU, string.h}
>  @safety{@mtsafe{}@assafe{}@acsafe{}}
>  This function returns the message describing the error @var{errnum} or

You need to put the return type in braces because it's not a single
identifier: {const char *}

Otherwise it's not rendered or indexed correctly.
Adhemerval Zanella Aug. 7, 2020, 8:17 p.m. UTC | #2
On 07/08/2020 17:04, Florian Weimer wrote:
> * Adhemerval Zanella via Libc-alpha:
> 
>> ---
>>  manual/errno.texi | 4 ++--
>>  1 file changed, 2 insertions(+), 2 deletions(-)
>>
>> diff --git a/manual/errno.texi b/manual/errno.texi
>> index 6ca566522d..7ac1554bb1 100644
>> --- a/manual/errno.texi
>> +++ b/manual/errno.texi
>> @@ -1207,7 +1207,7 @@ to @code{errno}.
>>  The function @code{perror} is declared in @file{stdio.h}.
>>  @end deftypefun
>>  
>> -@deftypefun void strerrorname_np (int @var{errnum})
>> +@deftypefun const char * strerrorname_np (int @var{errnum})
>>  @standards{GNU, string.h}
>>  @safety{@mtsafe{}@assafe{}@acsafe{}}
>>  This function returns the name describing the error @var{errnum} or
>> @@ -1218,7 +1218,7 @@ for @code{EINVAL}).
>>  This function is a GNU extension, declared in the header file @file{string.h}.
>>  @end deftypefun
>>  
>> -@deftypefun void strerrordesc_np (int @var{errnum})
>> +@deftypefun const char * strerrordesc_np (int @var{errnum})
>>  @standards{GNU, string.h}
>>  @safety{@mtsafe{}@assafe{}@acsafe{}}
>>  This function returns the message describing the error @var{errnum} or
> 
> You need to put the return type in braces because it's not a single
> identifier: {const char *}
> 
> Otherwise it's not rendered or indexed correctly.
> 

Right, I have fixed it.  I couldn't noticed any different in PDF output,
but it does show wrong rendering in HTML.
Florian Weimer Aug. 7, 2020, 8:31 p.m. UTC | #3
* Adhemerval Zanella:

> Right, I have fixed it.  I couldn't noticed any different in PDF output,
> but it does show wrong rendering in HTML.

Please also fix the new sig* functions in a similar way.
Adhemerval Zanella Aug. 8, 2020, 7:53 p.m. UTC | #4
On 07/08/2020 17:31, Florian Weimer wrote:
> * Adhemerval Zanella:
> 
>> Right, I have fixed it.  I couldn't noticed any different in PDF output,
>> but it does show wrong rendering in HTML.
> 
> Please also fix the new sig* functions in a similar way.
> 

Done.
diff mbox series

Patch

diff --git a/manual/errno.texi b/manual/errno.texi
index 6ca566522d..7ac1554bb1 100644
--- a/manual/errno.texi
+++ b/manual/errno.texi
@@ -1207,7 +1207,7 @@  to @code{errno}.
 The function @code{perror} is declared in @file{stdio.h}.
 @end deftypefun
 
-@deftypefun void strerrorname_np (int @var{errnum})
+@deftypefun const char * strerrorname_np (int @var{errnum})
 @standards{GNU, string.h}
 @safety{@mtsafe{}@assafe{}@acsafe{}}
 This function returns the name describing the error @var{errnum} or
@@ -1218,7 +1218,7 @@  for @code{EINVAL}).
 This function is a GNU extension, declared in the header file @file{string.h}.
 @end deftypefun
 
-@deftypefun void strerrordesc_np (int @var{errnum})
+@deftypefun const char * strerrordesc_np (int @var{errnum})
 @standards{GNU, string.h}
 @safety{@mtsafe{}@assafe{}@acsafe{}}
 This function returns the message describing the error @var{errnum} or