Bug 217148 - man-pages-posix: create symlinks during installation
Summary: man-pages-posix: create symlinks during installation
Status: ASSIGNED
Alias: None
Product: Documentation
Classification: Unclassified
Component: man-pages (show other bugs)
Hardware: All Linux
: P1 normal
Assignee: documentation_man-pages@kernel-bugs.osdl.org
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2023-03-06 18:01 UTC by Esteve Varela Colominas
Modified: 2023-05-19 12:02 UTC (History)
0 users

See Also:
Kernel Version:
Subsystem:
Regression: No
Bisected commit-id:


Attachments

Description Esteve Varela Colominas 2023-03-06 18:01:07 UTC
Doing some pthreads programming as of recently, I've found that the documentation is scattered across the man-pages and man-pages-posix projects.

Various pages refer to the existence of other pages, which simply don't exist in a default installation as created by "make install" of man-pages-posix. For example, pthreads(3) refers to pthread_cond_wait(3). Running "man pthread_cond_wait" will result in the man page not being found.

On the website[1], this page appears to be a symlink. The correct page it should lead to, being pthread_cond_wait(3p) (yes, 3p, not 3, as was referred). However, currently no distributions make a symlink for these, so the correct page is frequently hard to find.

I'd like to have a default set of man page symlinks created by the man-pages-posix distribution tarball, reflecting whatever the man7.org site does, such that these pages are more easily found, and the documentation is consistent across linux distributions.

Interestingly, debian has a set of pages[2] for some of the "missing" pages, but these aren't shipped in any other distribution I'm aware of.

[1]: https://man7.org/linux/man-pages/man3/pthread_cond_wait.3p.html
[2]: https://manpages.debian.org/bullseye/glibc-doc/index.html
Comment 1 Alejandro Colomar 2023-05-19 12:02:17 UTC
The man-pages-posix project is for POSIX documentation.  There is actual
glibc documentation for those phtreads functions, but it's not (yet?) in
the Linux man-pages project.  In Debian you can get those manual pages
through the glibc-doc package.  I've asked the maintainers to merge
those pages into the Linux man-pages project.

 
<https://lore.kernel.org/linux-man/703ec07e-dd2b-bbc6-f1bc-f495e53b764f@gmail.com/T/#u>

 
I hope we soon have these Debian pages in the project.

Note You need to log in before you can comment on or make changes to this bug.