All of lore.kernel.org
 help / color / mirror / Atom feed
From: bugzilla-daemon@kernel.org
To: linux-man@vger.kernel.org
Subject: [Bug 217148] New: man-pages-posix: create symlinks during installation
Date: Mon, 06 Mar 2023 18:01:07 +0000	[thread overview]
Message-ID: <bug-217148-11311@https.bugzilla.kernel.org/> (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: documentation_man-pages@kernel-bugs.osdl.org
          Reporter: esteve.varela@gmail.com
        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

-- 
You may reply to this email to add a comment.

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

             reply	other threads:[~2023-03-06 18:03 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-03-06 18:01 bugzilla-daemon [this message]
2023-05-19 12:02 ` [Bug 217148] man-pages-posix: create symlinks during installation bugzilla-daemon
2023-05-19 12:02 ` bugzilla-daemon

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=bug-217148-11311@https.bugzilla.kernel.org/ \
    --to=bugzilla-daemon@kernel.org \
    --cc=linux-man@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.