[PATCH] ecvt.3: Add description of the functions are not thread-safe

[PATCH] ecvt.3: Add description of the functions are not thread-safe

[Peng Haitao]

Hi Michael,

The functions "ecvt" and "fcvt" return a string located in a static buffer which
is overwritten by the next call to the functions, so they are not thread-safe.

Signed-off-by: Peng Haitao <penght-BthXqXjhjHXQFUHtdCDX3A@public.gmane.org>
---
 man3/ecvt.3 |    9 ++++++++-
 1 files changed, 8 insertions(+), 1 deletions(-)

diff --git a/man3/ecvt.3 b/man3/ecvt.3
index 0bc2a4f..83f51cc 100644
--- a/man3/ecvt.3
+++ b/man3/ecvt.3
@@ -27,7 +27,7 @@
 .\" Modified Sat Jul 24 19:40:39 1993 by Rik Faith (faith-+5Oa3zvhR2o3uPMLIKxrzw@public.gmane.org)
 .\" Modified Fri Jun 25 12:10:47 1999 by Andries Brouwer (aeb-rh8NL+sEX9E@public.gmane.org)
 .\"
-.TH ECVT 3 2010-09-20 "" "Linux Programmer's Manual"
+.TH ECVT 3 2010-12-23 "" "Linux Programmer's Manual"
 .SH NAME
 ecvt, fcvt \- convert a floating-point number to a string
 .SH SYNOPSIS
@@ -105,6 +105,13 @@ The static string is overwritten by each call to
 .BR ecvt ()
 or
 .BR fcvt ().
+.SH ATTRIBUTES
+.SS Multithreading (see pthreads(7))
+The
+.BR ecvt ()
+and
+.BR fcvt ()
+functions are not thread-safe.
 .SH "CONFORMING TO"
 SVr2;
 marked as LEGACY in POSIX.1-2001.
-- 
1.7.0.1


-- 
Best Regards,
Peng Haitao

--
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] ecvt.3: Add description of the functions are not thread-safe

[Peng Haitao]

The functions ecvt() and fcvt() return a string located in a static buffer which
is overwritten by the next call to the functions, so they are not thread-safe.

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

diff --git a/man3/ecvt.3 b/man3/ecvt.3
index c35879f..0506d1f 100644
--- a/man3/ecvt.3
+++ b/man3/ecvt.3
@@ -27,7 +27,7 @@
 .\" Modified Sat Jul 24 19:40:39 1993 by Rik Faith (faith-+5Oa3zvhR2o3uPMLIKxrzw@public.gmane.org)
 .\" Modified Fri Jun 25 12:10:47 1999 by Andries Brouwer (aeb-rh8NL+sEX9E@public.gmane.org)
 .\"
-.TH ECVT 3 2010-09-20 "" "Linux Programmer's Manual"
+.TH ECVT 3 2013-03-12 "" "Linux Programmer's Manual"
 .SH NAME
 ecvt, fcvt \- convert a floating-point number to a string
 .SH SYNOPSIS
@@ -105,6 +105,13 @@ The static string is overwritten by each call to
 .BR ecvt ()
 or
 .BR fcvt ().
+.SH ATTRIBUTES
+.SS Multithreading (see pthreads(7))
+The
+.BR ecvt ()
+and
+.BR fcvt ()
+functions are not thread-safe.
 .SH CONFORMING TO
 SVr2;
 marked as LEGACY in POSIX.1-2001.
-- 
1.8.1.4

--
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] ecvt.3: Add description of the functions are not thread-safe

[Michael Kerrisk (man-pages)]

Hello Peng,

Some general comments for all future patches:

For the future, I'd prefer patches with titles such as:

     ATTRIBUTES: Note functions that are not thread-safe

Also, please don't patch the date in the TH line. Normally, I would be
happy for patches to do this, but the way I'll deal with this patch
series, modifying the date is likely to cause some merge conflicts, so
I prefer that you leave fixing the date to me.

On Tue, Mar 12, 2013 at 11:41 AM, Peng Haitao <penght-BthXqXjhjHXQFUHtdCDX3A@public.gmane.org> wrote:
> The functions ecvt() and fcvt() return a string located in a static buffer which
> is overwritten by the next call to the functions, so they are not thread-safe.

I prefer to have the text of the patch description wrapping at column
65. When my scripts produce the changelog, then everything is a
maximum of 80 columns wide.

Also, in the changelog entry, it's probably not necessary to repeat
the text of the patch itself. The above text could be simplified to:

    The functions ecvt() and fcvt() are not thread safe.

I've applied this patch in my local branch for the ATTRIBUTES work.

Cheers,

Michael
> Signed-off-by: Peng Haitao <penght-BthXqXjhjHXQFUHtdCDX3A@public.gmane.org>
> ---
>  man3/ecvt.3 | 9 ++++++++-
>  1 file changed, 8 insertions(+), 1 deletion(-)
>
> diff --git a/man3/ecvt.3 b/man3/ecvt.3
> index c35879f..0506d1f 100644
> --- a/man3/ecvt.3
> +++ b/man3/ecvt.3
> @@ -27,7 +27,7 @@
>  .\" Modified Sat Jul 24 19:40:39 1993 by Rik Faith (faith-+5Oa3zvhR2o3uPMLIKxrzw@public.gmane.org)
>  .\" Modified Fri Jun 25 12:10:47 1999 by Andries Brouwer (aeb-rh8NL+sEX9E@public.gmane.org)
>  .\"
> -.TH ECVT 3 2010-09-20 "" "Linux Programmer's Manual"
> +.TH ECVT 3 2013-03-12 "" "Linux Programmer's Manual"
>  .SH NAME
>  ecvt, fcvt \- convert a floating-point number to a string
>  .SH SYNOPSIS
> @@ -105,6 +105,13 @@ The static string is overwritten by each call to
>  .BR ecvt ()
>  or
>  .BR fcvt ().
> +.SH ATTRIBUTES
> +.SS Multithreading (see pthreads(7))
> +The
> +.BR ecvt ()
> +and
> +.BR fcvt ()
> +functions are not thread-safe.
>  .SH CONFORMING TO
>  SVr2;
>  marked as LEGACY in POSIX.1-2001.
> --
> 1.8.1.4
>



-- 
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] ecvt.3: Add description of the functions are not thread-safe

[Peng Haitao]

Hi Michael,

I'm very sorry reply for you so late:(

On 03/17/2013 06:05 PM, Michael Kerrisk (man-pages) wrote:
> Some general comments for all future patches:
> 
> For the future, I'd prefer patches with titles such as:
> 
>      ATTRIBUTES: Note functions that are not thread-safe
> 
> Also, please don't patch the date in the TH line. Normally, I would be
> happy for patches to do this, but the way I'll deal with this patch
> series, modifying the date is likely to cause some merge conflicts, so
> I prefer that you leave fixing the date to me.
> 

I see.

> On Tue, Mar 12, 2013 at 11:41 AM, Peng Haitao <penght-BthXqXjhjHXQFUHtdCDX3A@public.gmane.org> wrote:
>> The functions ecvt() and fcvt() return a string located in a static buffer which
>> is overwritten by the next call to the functions, so they are not thread-safe.
> 
> I prefer to have the text of the patch description wrapping at column
> 65. When my scripts produce the changelog, then everything is a
> maximum of 80 columns wide.
> 
> Also, in the changelog entry, it's probably not necessary to repeat
> the text of the patch itself. The above text could be simplified to:
> 
>     The functions ecvt() and fcvt() are not thread safe.
> 

I see.

> I've applied this patch in my local branch for the ATTRIBUTES work.
> 

Thanks.


-- 
Best Regards,
Peng

> Cheers,
> 
> Michael
>> Signed-off-by: Peng Haitao <penght-BthXqXjhjHXQFUHtdCDX3A@public.gmane.org>
>> ---
>>  man3/ecvt.3 | 9 ++++++++-
>>  1 file changed, 8 insertions(+), 1 deletion(-)
>>
>> diff --git a/man3/ecvt.3 b/man3/ecvt.3
>> index c35879f..0506d1f 100644
>> --- a/man3/ecvt.3
>> +++ b/man3/ecvt.3
>> @@ -27,7 +27,7 @@
>>  .\" Modified Sat Jul 24 19:40:39 1993 by Rik Faith (faith-+5Oa3zvhR2o3uPMLIKxrzw@public.gmane.org)
>>  .\" Modified Fri Jun 25 12:10:47 1999 by Andries Brouwer (aeb-rh8NL+sEX9E@public.gmane.org)
>>  .\"
>> -.TH ECVT 3 2010-09-20 "" "Linux Programmer's Manual"
>> +.TH ECVT 3 2013-03-12 "" "Linux Programmer's Manual"
>>  .SH NAME
>>  ecvt, fcvt \- convert a floating-point number to a string
>>  .SH SYNOPSIS
>> @@ -105,6 +105,13 @@ The static string is overwritten by each call to
>>  .BR ecvt ()
>>  or
>>  .BR fcvt ().
>> +.SH ATTRIBUTES
>> +.SS Multithreading (see pthreads(7))
>> +The
>> +.BR ecvt ()
>> +and
>> +.BR fcvt ()
>> +functions are not thread-safe.
>>  .SH CONFORMING TO
>>  SVr2;
>>  marked as LEGACY in POSIX.1-2001.
>> --
>> 1.8.1.4
>>
> 
> 
> 

--
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