Issue in man page strcat.3

Issue in man page strcat.3

[Helge Kreutzmann]

Without further ado, the following was found:

Issue:   The variable I<size> is not defined above in the summary? Is this I<n>?

"This function appends the null-terminated string I<src> to the string "
"I<dest>, copying at most I<size-strlen(dest)-1> from I<src>, and adds a "
"terminating null byte to the result, I<unless> I<size> is less than "
"I<strlen(dest)>.  This function fixes the buffer overrun problem of "
"B<strcat>(), but the caller must still handle the possibility of data loss "
"if I<size> is too small.  The function returns the length of the string "
"B<strlcat>()  tried to create; if the return value is greater than or equal "
"to I<size>, data loss occurred.  If data loss matters, the caller I<must> "
"either check the arguments before the call, or test the function return "
"value.  B<strlcat>()  is not present in glibc and is not standardized by "
"POSIX, but is available on Linux via the I<libbsd> library."

Re: Issue in man page strcat.3

[Alejandro Colomar]

[-- Attachment #1.1: Type: text/plain, Size: 1209 bytes --]

Hi Helge,

On 12/4/22 10:07, Helge Kreutzmann wrote:
> Without further ado, the following was found:
> 
> Issue:   The variable I<size> is not defined above in the summary? Is this I<n>?
> 
> "This function appends the null-terminated string I<src> to the string"
> "I<dest>, copying at most I<size-strlen(dest)-1> from I<src>, and adds a"
> "terminating null byte to the result, I<unless> I<size> is less than"
> "I<strlen(dest)>.  This function fixes the buffer overrun problem of"
> "B<strcat>(), but the caller must still handle the possibility of data loss"
> "if I<size> is too small.  The function returns the length of the string"
> "B<strlcat>()  tried to create; if the return value is greater than or equal"
> "to I<size>, data loss occurred.  If data loss matters, the caller I<must>"
> "either check the arguments before the call, or test the function return"
> "value.  B<strlcat>()  is not present in glibc and is not standardized by"
> "POSIX, but is available on Linux via the I<libbsd> library."


The report is invalid.  That 'size' refers to the strlcat(3) prototype, declared 
in the same NOTES section.

Cheers,

Alex

-- 
<http://www.alejandro-colomar.es/>

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: Issue in man page strcat.3

[Helge Kreutzmann]

[-- Attachment #1: Type: text/plain, Size: 1654 bytes --]

Hello Alejandro,
On Sun, Dec 04, 2022 at 08:55:16PM +0100, Alejandro Colomar wrote:
> On 12/4/22 10:07, Helge Kreutzmann wrote:
> > Without further ado, the following was found:
> > 
> > Issue:   The variable I<size> is not defined above in the summary? Is this I<n>?
> > 
> > "This function appends the null-terminated string I<src> to the string"
> > "I<dest>, copying at most I<size-strlen(dest)-1> from I<src>, and adds a"
> > "terminating null byte to the result, I<unless> I<size> is less than"
> > "I<strlen(dest)>.  This function fixes the buffer overrun problem of"
> > "B<strcat>(), but the caller must still handle the possibility of data loss"
> > "if I<size> is too small.  The function returns the length of the string"
> > "B<strlcat>()  tried to create; if the return value is greater than or equal"
> > "to I<size>, data loss occurred.  If data loss matters, the caller I<must>"
> > "either check the arguments before the call, or test the function return"
> > "value.  B<strlcat>()  is not present in glibc and is not standardized by"
> > "POSIX, but is available on Linux via the I<libbsd> library."
> 
> 
> The report is invalid.  That 'size' refers to the strlcat(3) prototype,
> declared in the same NOTES section.

Thanks for the clarification!

I mark it as such in our files.

Greetings

           Helge


-- 
      Dr. Helge Kreutzmann                     debian@helgefjell.de
           Dipl.-Phys.                   http://www.helgefjell.de/debian.php
        64bit GNU powered                     gpg signed mail preferred
           Help keep free software "libre": http://www.ffii.de/

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]