Skip to contentSkip to conversation

New: man-pages-posix: create symlinks during installation

Bug 217148 [email protected] 1 participant 3 messages Mar 6, 2023 – May 19, 2023 Man-pages: manual pages for Linux -- Sections 2, 3, 4, 5, and 7

lore
Share & tools
lore
#0 lore raw

https://bugzilla.kernel.org/show_bug.cgi?id=217148

Bug ID: 217148
Summary: man-pages-posix: create symlinks during installation
Product: Documentation
Version: unspecified
Hardware: All
OS: Linux
Status: NEW
Severity: normal
Priority: P1
Component: man-pages
Assignee: [email protected]
Reporter: [email protected]
Regression: No

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

Signature · 4 lines
You may reply to this email to add a comment.

You are receiving this mail because:
You are watching the assignee of the bug.
#1 lore raw

[Bug 217148] man-pages-posix: create symlinks during installation

https://bugzilla.kernel.org/show_bug.cgi?id=217148

--- Comment #1 from Alejandro Colomar ([email protected]) --- 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/[email protected]/T/#u>

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

Signature · 4 lines
You may reply to this email to add a comment.

You are receiving this mail because:
You are watching the assignee of the bug.
#2 lore raw

[Bug 217148] man-pages-posix: create symlinks during installation

In reply to [email protected]

https://bugzilla.kernel.org/show_bug.cgi?id=217148

Alejandro Colomar ([email protected]) changed:

What |Removed |Added
----------------------------------------------------------------------------
Status|NEW |ASSIGNED

Signature · 4 lines
You may reply to this email to add a comment.

You are receiving this mail because:
You are watching the assignee of the bug.