1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
|
# Build instructions for podlators.
#
# We need to use ExtUtils::MakeMaker since this module is part of Perl core,
# which only supports that build method, and because it is a dependency of
# other build systems like Module::Build.
#
# Copyright 1999-2001, 2008, 2010, 2012, 2014-2016, 2018-2019, 2022
# Russ Allbery <rra@cpan.org>
#
# This program is free software; you may redistribute it and/or modify it
# under the same terms as Perl itself.
#
# SPDX-License-Identifier: GPL-1.0-or-later OR Artistic-1.0-Perl
use 5.008;
use strict;
use warnings;
use Config;
use ExtUtils::MakeMaker;
use File::Spec;
# Determine the version of the distribution so that we can construct the
# provides metadata that unfortunately ExtUtils::MakeMaker does not build.
# This is a very simple $VERSION parser, since it only has to handle the
# syntax Pod::Man uses.
#
# Returns: Distribution version as a string
sub dist_version {
open(my $fh, '<', File::Spec->catfile('lib', 'Pod', 'Man.pm'))
or die "$0: cannot open lib/Pod/Man.pm: $!\n";
while (defined(my $line = <$fh>)) {
if ($line =~ m{ \A (?:our \s+)? \$VERSION \s+ = \s+ '([^\']+)' }xms) {
close($fh) or die "$0: cannot close lib/Pod/Man.pm\n";
return $1;
}
}
close($fh) or die "$0: cannot close lib/Pod/Man.pm\n";
die "$0: cannot find version in lib/Pod/Man.pm\n";
}
# Generate full paths for scripts distributed in the bin directory. Appends
# the .com extension to scripts on VMS, unless they already have the .PL
# extension.
#
# @scripts - List of script names
#
# Returns: (Array) List of relative paths from top of distribution
# (Scalar) Space-separated relative paths from top of distribution
sub scripts {
my (@scripts) = @_;
my @paths = map { File::Spec->catfile('scripts', $_) } @scripts;
if ($^O eq 'VMS') {
@paths = map { m{ [.] PL \z }xms ? $_ : $_ . '.com' } @paths;
}
return wantarray ? @paths : join(q{ }, @paths);
}
# Generate an association between a source file and a destination man page for
# non-module man pages. ExtUtils::MakeMaker only really understands how to
# generate man pages for modules, so we need to help it for the script man
# pages and (particularly) the perlpodstyle man page.
#
# $directory - Directory containing the file
# $file - File containing POD in that directory
#
# Returns: The path to the file with POD and the output man page, as a pair
sub man1pod {
my ($directory, $file) = @_;
# Build the base name of the file by stripping any *.pod or *.PL suffix.
my $basename = $file;
$basename =~ s{ [.] (?: pod | PL ) \z }{}xms;
# Determine the output file name for the generated man page.
my $outname = $basename . q{.} . $Config{man1ext};
my $outpath = File::Spec->catfile(qw(blib man1), $outname);
return (File::Spec->catfile($directory, $file), $outpath);
}
# The hash of all the metadata. This will be modified before WriteMakefile to
# remove keys not supported by the local version of ExtUtils::MakeMaker.
my $dist_version = dist_version();
my %metadata = (
#<<<
NAME => 'Pod',
DISTNAME => 'podlators',
ABSTRACT => 'Convert POD data to various other formats',
AUTHOR => 'Russ Allbery <rra@cpan.org>',
LICENSE => 'perl_5',
EXE_FILES => [scripts('pod2text', 'pod2man')],
VERSION_FROM => 'lib/Pod/Man.pm',
MIN_PERL_VERSION => '5.010',
#>>>
# Use *.PL files to generate the driver scripts so that we get the correct
# invocation of Perl on non-UNIX platforms.
PL_FILES => {
scripts('pod2man.PL', 'pod2man'), scripts('pod2text.PL', 'pod2text'),
},
# Override the files that generate section 1 man pages.
MAN1PODS => {
man1pod('scripts', 'pod2man.PL'),
man1pod('scripts', 'pod2text.PL'),
# Perl core uses a separate copy in the top-level pod directory.
($ENV{PERL_CORE} ? () : man1pod('pod', 'perlpodstyle.pod')),
},
# Clean some additional files.
clean => { FILES => File::Spec->catdir('t', 'tmp') },
realclean => { FILES => scalar(scripts('pod2text', 'pod2man')) },
# Dependencies on other modules.
PREREQ_PM => { 'Pod::Simple' => 3.26 },
# Older versions of ExtUtils::MakeMaker don't pick up nested test
# directories by default.
test => { TESTS => 't/*/*.t' },
# For older versions of Perl, we have to force installation into the Perl
# module directories since site modules did not take precedence over core
# modules.
INSTALLDIRS => $] lt '5.011' ? 'perl' : 'site',
# Additional metadata.
META_ADD => {
'meta-spec' => { version => 2 },
provides => {
'Pod::Man' => {
file => 'lib/Pod/Man.pm',
version => $dist_version,
},
'Pod::ParseLink' => {
file => 'lib/Pod/ParseLink.pm',
version => $dist_version,
},
'Pod::Text' => {
file => 'lib/Pod/Text.pm',
version => $dist_version,
},
'Pod::Text::Color' => {
file => 'lib/Pod/Text/Color.pm',
version => $dist_version,
},
'Pod::Text::Overstrike' => {
file => 'lib/Pod/Text/Overstrike.pm',
version => $dist_version,
},
'Pod::Text::Termcap' => {
file => 'lib/Pod/Text/Termcap.pm',
version => $dist_version,
},
},
resources => {
bugtracker => {
web => 'https://github.com/rra/podlators/issues',
},
homepage => 'https://www.eyrie.org/~eagle/software/podlators/',
repository => {
url => 'https://github.com/rra/podlators.git',
web => 'https://github.com/rra/podlators',
type => 'git',
},
},
},
);
# Remove keys that aren't supported by this version of ExtUtils::MakeMaker.
# This hash maps keys to the minimum supported version.
my %supported = (
LICENSE => 6.31,
META_ADD => 6.46,
MIN_PERL_VERSION => 6.48,
);
for my $key (keys(%supported)) {
if ($ExtUtils::MakeMaker::VERSION < $supported{$key}) {
delete $metadata{$key};
}
}
# Generate the actual Makefile. Pick an arbitrary module to pull the version
# from, since they should all have the same version.
WriteMakefile(%metadata);
|
