[PATCH 1/2] man-pages.7: Add description of "ATTRIBUTES"

[PATCH 1/2] man-pages.7: Add description of "ATTRIBUTES"

[Peng Haitao]

"ATTRIBUTES" section gives the information of thread-safety.

Signed-off-by: Peng Haitao <penght-BthXqXjhjHXQFUHtdCDX3A@public.gmane.org>
---
 man7/man-pages.7 | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

diff --git a/man7/man-pages.7 b/man7/man-pages.7
index b21de1d..8533cfb 100644
--- a/man7/man-pages.7
+++ b/man7/man-pages.7
@@ -25,7 +25,7 @@
 .\" 2007-05-30 created by mtk, using text from old man.7 plus
 .\" rewrites and additional text.
 .\"
-.TH MAN-PAGES 7 2012-10-21 "Linux" "Linux Programmer's Manual"
+.TH MAN-PAGES 7 2012-12-04 "Linux" "Linux Programmer's Manual"
 .SH NAME
 man-pages \- conventions for writing Linux man pages
 .SH SYNOPSIS
@@ -181,6 +181,7 @@ ERRORS             [Typically only in Sections 2, 3]
 ENVIRONMENT
 FILES
 VERSIONS           [Normally only in Sections 2, 3]
+ATTRIBUTES         [Normally only in Sections 2, 3]
 CONFORMING TO
 NOTES
 BUGS
@@ -342,6 +343,21 @@ The
 manual page also provides information about kernel versions
 in which various system calls first appeared.
 .TP
+.B ATTRIBUTES
+For Section 2 and 3 manual pages, this section gives a
+number of attributes, e.g.,
+.RS
+.TS
+allbox;
+c.
+thread-safety
+reentrant/non-reentrant
+async-signal-safety
+cancelation safety
+.TE
+.RE
+.TP
+.sp
 .B CONFORMING TO
 describes any standards or conventions that relate to the function
 or command described by the manual page.
-- 
1.8.0

--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[PATCH 2/2] bindresvport.3: Add description of the function is thread-safe

[Peng Haitao]

The function bindresvport() uses lock to protect static variable,
so it is thread-safe. The patch can refer to URL:
http://sourceware.org/git/?p=glibc.git;a=commit;h=f6da27e53695ad1cc0e2a9490358decbbfdff5e5

Signed-off-by: Peng Haitao <penght-BthXqXjhjHXQFUHtdCDX3A@public.gmane.org>
---
 man3/bindresvport.3 | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/man3/bindresvport.3 b/man3/bindresvport.3
index d58c33d..facc297 100644
--- a/man3/bindresvport.3
+++ b/man3/bindresvport.3
@@ -24,7 +24,7 @@
 .\" 2007-05-31, mtk: Rewrite and substantial additional text.
 .\" 2008-12-03, mtk: Rewrote some pieces and fixed some errors
 .\"
-.TH BINDRESVPORT 3  2008-12-03 "" "Linux Programmer's Manual"
+.TH BINDRESVPORT 3  2012-12-04 "" "Linux Programmer's Manual"
 .SH NAME
 bindresvport \- bind a socket to a privileged IP port
 .SH SYNOPSIS
@@ -86,6 +86,11 @@ is not NULL and
 .I sin->sin_family
 is not
 .BR AF_INET .
+.SH ATTRIBUTES
+.SS Multithreading (see pthreads(7))
+The
+.BR bindresvport ()
+function is thread-safe.
 .SH "CONFORMING TO"
 Not in POSIX.1-2001.
 Present on the BSDs, Solaris, and many other systems.
-- 
1.8.0

--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH 2/2] bindresvport.3: Add description of the function is thread-safe

[Michael Kerrisk (man-pages)]

Hello Peng,

On Tue, Dec 4, 2012 at 8:55 AM, Peng Haitao <penght-BthXqXjhjHXQFUHtdCDX3A@public.gmane.org> wrote:
> The function bindresvport() uses lock to protect static variable,
> so it is thread-safe. The patch can refer to URL:
> http://sourceware.org/git/?p=glibc.git;a=commit;h=f6da27e53695ad1cc0e2a9490358decbbfdff5e5

Now we get to an interesting case. If I understand right,
bindresvport() was not thread-safe, but you have now made it so,
correct?

In this case, the ATTRIBUTES patch should say something like:

    Before glibc 2.??, bindresvport() was not thread-safe.
    Since glibc 2.??, it is thread-safe.

And the changelog should include the information you gave above.
Could you please resubmit this patch.

Cheers,

Michael

> Signed-off-by: Peng Haitao <penght-BthXqXjhjHXQFUHtdCDX3A@public.gmane.org>
> ---
>  man3/bindresvport.3 | 7 ++++++-
>  1 file changed, 6 insertions(+), 1 deletion(-)
>
> diff --git a/man3/bindresvport.3 b/man3/bindresvport.3
> index d58c33d..facc297 100644
> --- a/man3/bindresvport.3
> +++ b/man3/bindresvport.3
> @@ -24,7 +24,7 @@
>  .\" 2007-05-31, mtk: Rewrite and substantial additional text.
>  .\" 2008-12-03, mtk: Rewrote some pieces and fixed some errors
>  .\"
> -.TH BINDRESVPORT 3  2008-12-03 "" "Linux Programmer's Manual"
> +.TH BINDRESVPORT 3  2012-12-04 "" "Linux Programmer's Manual"
>  .SH NAME
>  bindresvport \- bind a socket to a privileged IP port
>  .SH SYNOPSIS
> @@ -86,6 +86,11 @@ is not NULL and
>  .I sin->sin_family
>  is not
>  .BR AF_INET .
> +.SH ATTRIBUTES
> +.SS Multithreading (see pthreads(7))
> +The
> +.BR bindresvport ()
> +function is thread-safe.
>  .SH "CONFORMING TO"
>  Not in POSIX.1-2001.
>  Present on the BSDs, Solaris, and many other systems.
> --
> 1.8.0
>
> --
> To unsubscribe from this list: send the line "unsubscribe linux-man" in
> the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html



-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Author of "The Linux Programming Interface"; http://man7.org/tlpi/
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH 2/2] bindresvport.3: Add description of the function is thread-safe

[Peng Haitao]

Hi Michael,

On 03/17/2013 07:06 PM, Michael Kerrisk (man-pages) wrote:
> On Tue, Dec 4, 2012 at 8:55 AM, Peng Haitao <penght-BthXqXjhjHXQFUHtdCDX3A@public.gmane.org> wrote:
>> The function bindresvport() uses lock to protect static variable,
>> so it is thread-safe. The patch can refer to URL:
>> http://sourceware.org/git/?p=glibc.git;a=commit;h=f6da27e53695ad1cc0e2a9490358decbbfdff5e5
> 
> Now we get to an interesting case. If I understand right,
> bindresvport() was not thread-safe, but you have now made it so,
> correct?
> 

Yes:）

> In this case, the ATTRIBUTES patch should say something like:
> 
>     Before glibc 2.??, bindresvport() was not thread-safe.
>     Since glibc 2.??, it is thread-safe.
> 
> And the changelog should include the information you gave above.
> Could you please resubmit this patch.
> 

Thanks, I will send v2 patch.


-- 
Best Regards,
Peng

> Cheers,
> 
> Michael
> 
>> Signed-off-by: Peng Haitao <penght-BthXqXjhjHXQFUHtdCDX3A@public.gmane.org>
>> ---
>>  man3/bindresvport.3 | 7 ++++++-
>>  1 file changed, 6 insertions(+), 1 deletion(-)
>>
>> diff --git a/man3/bindresvport.3 b/man3/bindresvport.3
>> index d58c33d..facc297 100644
>> --- a/man3/bindresvport.3
>> +++ b/man3/bindresvport.3
>> @@ -24,7 +24,7 @@
>>  .\" 2007-05-31, mtk: Rewrite and substantial additional text.
>>  .\" 2008-12-03, mtk: Rewrote some pieces and fixed some errors
>>  .\"
>> -.TH BINDRESVPORT 3  2008-12-03 "" "Linux Programmer's Manual"
>> +.TH BINDRESVPORT 3  2012-12-04 "" "Linux Programmer's Manual"
>>  .SH NAME
>>  bindresvport \- bind a socket to a privileged IP port
>>  .SH SYNOPSIS
>> @@ -86,6 +86,11 @@ is not NULL and
>>  .I sin->sin_family
>>  is not
>>  .BR AF_INET .
>> +.SH ATTRIBUTES
>> +.SS Multithreading (see pthreads(7))
>> +The
>> +.BR bindresvport ()
>> +function is thread-safe.
>>  .SH "CONFORMING TO"
>>  Not in POSIX.1-2001.
>>  Present on the BSDs, Solaris, and many other systems.
>> --
>> 1.8.0
>>
>> --
>> To unsubscribe from this list: send the line "unsubscribe linux-man" in
>> the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
>> More majordomo info at  http://vger.kernel.org/majordomo-info.html
> 
> 
> 

--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html