Skip to contentSkip to conversation

Documenting MT-safe vs. MT-unsafe.

DISCUSSION Carlos O'Donell 2 participants 2 messages Jul 25, 2013 1 message not in the archive Man-pages: manual pages for Linux -- Sections 2, 3, 4, 5, and 7

lore
Share & tools
lore
#0 lore raw

Peng,

The work that you are doing documenting multithreading safety in the linux kernel man pages is excellent, and very useful. Thank you for working on this.

Michael, Peng,

At present I am a little worried that glibc is going to document what we want to be true e.g. MT-unsafe, but that the linux kernel man pages project is going to document what is actually implemented e.g. MT-safe. This may lead users to believe functions are safe when they are not guaranteed to be so.

The other problem is that the two documents might
diverge and this information is very important.

What can we do to keep the two documents in sync?

When Alex completes his project we'll have MT-safety data (with a series of exceptions) for almost all of the glibc functions. Could we use that data to drive the generation of the attributes in the linux kernel man pages?

Comments?

Cheers,
Carlos.
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in the body of a message to [email protected] More majordomo info at http://vger.kernel.org/majordomo-info.html

A message that is not in the archive (sent off-list or not yet received): [email protected]

#2 lore raw
Quoted 7 lines · Carlos O'Donell

At present I am a little worried that glibc is going to document what we want to be true e.g. MT-unsafe, but that the linux kernel man pages project is going to document what is actually implemented e.g. MT-safe. This may lead users to believe functions are safe when they are not guaranteed to be so.

Quoted 5 lines

The other problem is that the two documents might diverge and this information is very important.

What can we do to keep the two documents in sync?

At present, when make the patch, I will look up Alex's result (branch lxoliva/thread-safety-docs).
If thread-safety level is the same with Alex or POSIX, I will send the patch. otherwise, the patch will be put off.

Quoted 6 lines

When Alex completes his project we'll have MT-safety data (with a series of exceptions) for almost all of the glibc functions. Could we use that data to drive the generation of the attributes in the linux kernel man pages?

Maybe this will wait for a long time:(

Signature · 2 lines
Best Regards,
Peng
Quoted 5 lines

Comments?

Cheers,
Carlos.

--
To unsubscribe from this list: send the line "unsubscribe linux-man" in the body of a message to [email protected] More majordomo info at http://vger.kernel.org/majordomo-info.html