Re: NPTL docs inquiry

2017-08-11 Thread Michael Kerrisk (man-pages)
On 08/11/2017 10:11 AM, Yubin Ruan wrote:
> 2017-08-09 3:27 GMT+08:00 Michael Kerrisk (man-pages) 
> :
>>
>> Hi,
>>
>> On 08/07/2017 06:42 PM, Randy Dunlap wrote:
>>> On 08/07/2017 09:31 AM, Yubin Ruan wrote:
 Hi, I am wondering whether there is any progress for NPTL. In page[1]
 I see lots of pthread-related pages are missing. Pretty shocked by
 that.

 Are there any plan for that? Who is the maintainer of NPTL? Why are
 such an important lib missing manual pages?
>>
>> Because no-one wrote all of them yet. I know it's not what you
>> hope to hear, but contributions are welcome.
>>
>> Note, by the way, that the Linux man-pages project sits outside of
>> the glibc project. The documentation for that project is the
>> glibc manual, but many things also are not documented there.
>>
>> Also, there are the POSIX man pages, which are distributed by the
>> Linux man-pages project. These are extracts from POSIX, and document
>> (the standard behavior) of all of the pthreads functions that are in
>> POSIX. Installing those pages may give you some of what you want.
>>
 [1]: https://www.kernel.org/doc/man-pages/missing_pages.html
>>>
>>> [adding Michael Kerrisk]
>>>
>>> Wikipedia says:
>>> {in https://en.wikipedia.org/wiki/Native_POSIX_Thread_Library}
>>>
>>> "NPTL has been part of Red Hat Enterprise Linux since version 3, and
>>> in the Linux kernel since version 2.6. It is now a fully integrated
>>> part of the GNU C Library.[2]"
>>>
>>> so I would expect the documentation to be part of that library.
> 
> Hi,
> I can write some of them, although I cannot guarantee when I can finish that.
> If anyone is doing this already or have any suggestions please let me know.
> 
> Not sure whether I am qualified for that, but I would like to try.
> I am going to port some pages from the POSIX thread standard docs, testing
> every features and modify the docs correspondingly.

Yubin,

Thanks for the offer to help. I suggest to start small, with one or two
pages that are free-standing (i.e., not part of a group of closely
related functions).  Be aware that the POSIX.1 man pages are copyright,
under a nonfree license. You can't just produce modified versions
of those pages. Rather, the new pages must be written in your own words.

Thanks,

Michael


-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html


Re: NPTL docs inquiry

2017-08-11 Thread Yubin Ruan
2017-08-09 3:27 GMT+08:00 Michael Kerrisk (man-pages) :
>
> Hi,
>
> On 08/07/2017 06:42 PM, Randy Dunlap wrote:
> > On 08/07/2017 09:31 AM, Yubin Ruan wrote:
> >> Hi, I am wondering whether there is any progress for NPTL. In page[1]
> >> I see lots of pthread-related pages are missing. Pretty shocked by
> >> that.
> >>
> >> Are there any plan for that? Who is the maintainer of NPTL? Why are
> >> such an important lib missing manual pages?
>
> Because no-one wrote all of them yet. I know it's not what you
> hope to hear, but contributions are welcome.
>
> Note, by the way, that the Linux man-pages project sits outside of
> the glibc project. The documentation for that project is the
> glibc manual, but many things also are not documented there.
>
> Also, there are the POSIX man pages, which are distributed by the
> Linux man-pages project. These are extracts from POSIX, and document
> (the standard behavior) of all of the pthreads functions that are in
> POSIX. Installing those pages may give you some of what you want.
>
> >> [1]: https://www.kernel.org/doc/man-pages/missing_pages.html
> >
> > [adding Michael Kerrisk]
> >
> > Wikipedia says:
> > {in https://en.wikipedia.org/wiki/Native_POSIX_Thread_Library}
> >
> > "NPTL has been part of Red Hat Enterprise Linux since version 3, and
> > in the Linux kernel since version 2.6. It is now a fully integrated
> > part of the GNU C Library.[2]"
> >
> > so I would expect the documentation to be part of that library.

Hi,
I can write some of them, although I cannot guarantee when I can finish that.
If anyone is doing this already or have any suggestions please let me know.

Not sure whether I am qualified for that, but I would like to try.
I am going to port some pages from the POSIX thread standard docs, testing
every features and modify the docs correspondingly.

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


Re: NPTL docs inquiry

2017-08-08 Thread Michael Kerrisk (man-pages)
Hi,

On 08/07/2017 06:42 PM, Randy Dunlap wrote:
> On 08/07/2017 09:31 AM, Yubin Ruan wrote:
>> Hi, I am wondering whether there is any progress for NPTL. In page[1]
>> I see lots of pthread-related pages are missing. Pretty shocked by
>> that.
>>
>> Are there any plan for that? Who is the maintainer of NPTL? Why are
>> such an important lib missing manual pages?

Because no-one wrote all of them yet. I know it's not what you
hope to hear, but contributions are welcome.

Note, by the way, that the Linux man-pages project sits outside of
the glibc project. The documentation for that project is the
glibc manual, but many things also are not documented there.

Also, there are the POSIX man pages, which are distributed by the 
Linux man-pages project. These are extracts from POSIX, and document
(the standard behavior) of all of the pthreads functions that are in
POSIX. Installing those pages may give you some of what you want.

>> [1]: https://www.kernel.org/doc/man-pages/missing_pages.html
> 
> [adding Michael Kerrisk]
> 
> Wikipedia says:
> {in https://en.wikipedia.org/wiki/Native_POSIX_Thread_Library}
> 
> "NPTL has been part of Red Hat Enterprise Linux since version 3, and
> in the Linux kernel since version 2.6. It is now a fully integrated
> part of the GNU C Library.[2]"
> 
> so I would expect the documentation to be part of that library.

Cheers,

Michael
 


-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html


Re: NPTL docs inquiry

2017-08-07 Thread Randy Dunlap
On 08/07/2017 09:31 AM, Yubin Ruan wrote:
> Hi, I am wondering whether there is any progress for NPTL. In page[1]
> I see lots of pthread-related pages are missing. Pretty shocked by
> that.
> 
> Are there any plan for that? Who is the maintainer of NPTL? Why are
> such an important lib missing manual pages?
> 
> [1]: https://www.kernel.org/doc/man-pages/missing_pages.html

[adding Michael Kerrisk]

Wikipedia says:
{in https://en.wikipedia.org/wiki/Native_POSIX_Thread_Library}

"NPTL has been part of Red Hat Enterprise Linux since version 3, and in the 
Linux kernel since version 2.6. It is now a fully integrated part of the GNU C 
Library.[2]"

so I would expect the documentation to be part of that library.


-- 
~Randy
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html