-
Notifications
You must be signed in to change notification settings - Fork 540
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[doc] All man pages' SEE ALSO sections should have standard section numbers added #17309
Comments
No, because these are meant to link to other perldocs, whereas links to manpage-style sections are handled differently. |
Yeah, the system isn't designed for this, sadly |
A possible change would be the addition of manpage section identifications to all of the But I think it should be possible to write a pod2man variant which does some heuristics to add manpage sections to links e.g. everything which "looks" like a perl module or can be found in |
Such would be possible but it could only be an imperfect heuristic, because of modules that look like "lib" or documentation like "perl". |
All I know is on Debian
$ dlocate perldoc.
perl-doc: /usr/share/man/man1/perldoc.1.gz
perl-doc: /usr/share/perl/5.30.0/pod/perldoc.pod
Maybe just the
/usr/share/man/man*/*.gz
files could have the standard section numbers added to them.
|
That sort of os/distribution specific logic sounds like a nightmare to maintain. |
I would add, this would be something an OS distribution could patch in their packages if desired, and that would be the level at which you'd know the pertinent information of what section any particular link will be in. |
I would add, this would be something an OS distribution could patch in their packages if desired
Great. However please tell them for me. I think I sent too much stuff to them.
https://bugs.debian.org/cgi-bin/pkgreport.cgi?ordering=raw;package=perl-doc;submitter=jidanni%40jidanni.org
|
A major problem with this logic, is that it assumes the module/script that is referred to is installed on the machine that builds the package. This is not a safe assumption. |
Just the other day we were having an argument about if e.g.,
$ man perldoc
should instead say
I.e., all perl man pages' SEE ALSO sections should have standard numbers attached to them,
like
$ man cat
has.
The text was updated successfully, but these errors were encountered: