Don't try to link to INSTALL which is not linkable documentation #23182
Conversation
|
podchecker suggests linking to INSTALL which doesn't make sense for the reason this PR exists |
| push @links, $3 if defined $3; | ||
| foreach my $link (@links) { | ||
| if ($link eq 'INSTALL') { | ||
| s/ \b INSTALL \b /C<L<INSTALL>>/xg; |
There was a problem hiding this comment.
Why not turn INSTALL here into L<INSTALL>?
There was a problem hiding this comment.
INSTALL is not a linkable documentation page (installed module, pod, or script), it is a file that comes with the tarball.
There was a problem hiding this comment.
Or looking at it the other way, L<INSTALL> would be a link to a hypothetical INSTALL.pm module on CPAN. (Would you look at that, https://metacpan.org/pod/INSTALL actually exists.)
There was a problem hiding this comment.
A good demonstration that we have no permissions system for documentation names, and that .pod files contained in releases should be namespaced (or written in a format not special cased by Perl tools).
|
|
||
| Perl's L<INSTALL> file has been clarified to explicitly state that Perl | ||
| Perl's F<INSTALL> file has been clarified to explicitly state that Perl | ||
| requires a C89 compliant ANSI C Compiler. |
There was a problem hiding this comment.
I know this isn't part of your patch, but Isn't perl C99 now days?
There was a problem hiding this comment.
Yes (partially), but this is perl5122delta, which was released 15 years ago.
Also remove the code in autodoc.pl which attempts to create these links.
mauke
force-pushed
the
cant-link-to-install
branch
from
fd1e54c to
cc1af7b
Compare
5 participants
Also remove the code in autodoc.pl which attempts to create these links.