Skip to content

Commit 39bf0de

Browse files
GrinnzLeont
authored andcommitted
Don't try to link to INSTALL which is not linkable documentation
Also remove the code in autodoc.pl which attempts to create these links.
1 parent 6d600bc commit 39bf0de

File tree

7 files changed

+18
-19
lines changed

7 files changed

+18
-19
lines changed

Porting/todo.pod

+1-1
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ to do this manually are roughly
288288
=item *
289289

290290
do a normal C<Configure>, but include Devel::Cover as a module to install
291-
(see L<INSTALL> for how to do this)
291+
(see F<INSTALL> for how to do this)
292292

293293
=item *
294294

README.bs2000

+1-1
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ Thomas Dorner
219219

220220
=head1 SEE ALSO
221221

222-
L<INSTALL>, L<perlport>.
222+
F<INSTALL>, L<perlport>.
223223

224224
=head2 Mailing list
225225

autodoc.pl

+12-13
Original file line numberDiff line numberDiff line change
@@ -1224,21 +1224,24 @@ sub parse_config_h {
12241224
| sh | SH | exe ) \b
12251225
!xx;
12261226
my $path_name_qr = qr! (?: / \w+ )+ !x;
1227-
for my $re ($file_name_qr, $path_name_qr) {
1228-
s! (*nlb:[ < \w / ]) ( $re ) !<$1>!gxx;
1229-
}
1227+
my $file_or_path_name_qr = qr!
1228+
$file_name_qr
1229+
|
1230+
$path_name_qr
1231+
|
1232+
INSTALL \b
1233+
!x;
1234+
s! (*nlb:[ < \w / ]) ( $file_or_path_name_qr ) !<$1>!gxx;
12301235

12311236
# Enclose <... file/path names with F<...> (but no double
12321237
# angle brackets)
1233-
for my $re ($file_name_qr, $path_name_qr) {
1234-
s! < ( $re ) > !F<$1>!gxx;
1235-
}
1238+
s! < ( $file_or_path_name_qr ) > !F<$1>!gxx;
12361239

12371240
# Explain metaconfig units
12381241
s/ ( \w+ \. U \b ) /$1 (part of metaconfig)/gx;
12391242

12401243
# Convert "See foo" to "See C<L</foo>>" if foo is described in
1241-
# this file. Also create a link to the known file INSTALL.
1244+
# this file.
12421245
# And, to be more general, handle "See also foo and bar", and
12431246
# "See also foo, bar, and baz"
12441247
while (m/ \b [Ss]ee \s+
@@ -1249,10 +1252,7 @@ sub parse_config_h {
12491252
push @links, $2 if defined $2;
12501253
push @links, $3 if defined $3;
12511254
foreach my $link (@links) {
1252-
if ($link eq 'INSTALL') {
1253-
s/ \b INSTALL \b /C<L<INSTALL>>/xg;
1254-
}
1255-
elsif (grep { $link =~ / \b $_ \b /x } keys %configs) {
1255+
if (grep { $link =~ / \b $_ \b /x } keys %configs) {
12561256
s| \b $link \b |C<L</$link>>|xg;
12571257
$configs{$link}{linked} = 1;
12581258
$configs{$name}{linked} = 1;
@@ -1261,15 +1261,14 @@ sub parse_config_h {
12611261
}
12621262

12631263
# Enclose what we think are symbols with C<...>.
1264-
no warnings 'experimental::vlb';
12651264
s/ (*nlb:<)
12661265
(
12671266
# Any word followed immediately with parens or
12681267
# brackets
12691268
\b \w+ (?: \( [^)]* \) # parameter list
12701269
| \[ [^]]* \] # or array reference
12711270
)
1272-
| (*plb: ^ | \s ) -D \w+ # Also -Dsymbols.
1271+
| (*nlb: \S ) -D \w+ # Also -Dsymbols.
12731272
| \b (?: struct | union ) \s \w+
12741273
12751274
# Words that contain underscores (which are

pod/perl5122delta.pod

+1-1
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ role in the exception mechanism.
122122

123123
=item *
124124

125-
Perl's L<INSTALL> file has been clarified to explicitly state that Perl
125+
Perl's F<INSTALL> file has been clarified to explicitly state that Perl
126126
requires a C89 compliant ANSI C Compiler.
127127

128128
=item *

pod/perlrun.pod

+1-1
Original file line numberDiff line numberDiff line change
@@ -444,7 +444,7 @@ B<-D14> is equivalent to B<-Dtls>):
444444
All these flags require B<-DDEBUGGING> when you compile the Perl
445445
executable (but see C<:opd> in L<Devel::Peek> or L<re/'debug' mode>
446446
which may change this).
447-
See the L<INSTALL> file in the Perl source distribution
447+
See the F<INSTALL> file in the Perl source distribution
448448
for how to do this.
449449

450450
If you're just trying to get a print out of each line of Perl code

pod/perlunicode.pod

+1-1
Original file line numberDiff line numberDiff line change
@@ -2086,7 +2086,7 @@ Download the files in the desired version of Unicode from the Unicode web
20862086
site L<https://www.unicode.org>). These should replace the existing files in
20872087
F<lib/unicore> in the Perl source tree. Follow the instructions in
20882088
F<README.perl> in that directory to change some of their names, and then build
2089-
perl (see L<INSTALL>).
2089+
perl (see F<INSTALL>).
20902090

20912091
=head2 Porting code from perl-5.6.X
20922092

pod/perlvar.pod

+1-1
Original file line numberDiff line numberDiff line change
@@ -594,7 +594,7 @@ Then
594594
$^M = 'a' x (1 << 16);
595595

596596
would allocate a 64K buffer for use in an emergency. See the
597-
L<INSTALL> file in the Perl distribution for information on how to
597+
F<INSTALL> file in the Perl distribution for information on how to
598598
add custom C compilation flags when compiling perl. To discourage casual
599599
use of this advanced feature, there is no L<English|English> long name for
600600
this variable.

0 commit comments

Comments
 (0)