mirror of
https://git.openafs.org/openafs.git
synced 2025-01-19 15:30:14 +00:00
a792acdadc
Add a preprocessor for POD documentation that handles a custom =include directive. Demonstrate how to use the preprocessor by factoring out all the standard PTS options into a separate POD fragment and including that fragment in all the PTS commands that take the standard options instead of including that documentation in each separate file. Change-Id: If5255efc6d3fc670b38a9898b3d7d3c60af04fcf Reviewed-on: http://gerrit.openafs.org/2440 Reviewed-by: Derrick Brashear <shadow@dementia.org> Tested-by: Derrick Brashear <shadow@dementia.org>
45 lines
1.6 KiB
Perl
Executable File
45 lines
1.6 KiB
Perl
Executable File
#!/usr/bin/perl -w
|
|
#
|
|
# POD currently doesn't support any sort of =include directive. This
|
|
# processor works around that limitation. It takes a list of files ending in
|
|
# *.in as its argument and processes any POD directives of the form =include
|
|
# <file> in that file, generating a file with the *.in suffix removed. All
|
|
# paths are taken to be relative to the directory containing the file being
|
|
# processed.
|
|
#
|
|
# Currently, only single include nesting is supported. The included file is
|
|
# not processed for additional =include statements.
|
|
|
|
require 5.006;
|
|
|
|
use Cwd qw(getcwd);
|
|
use File::Basename qw(dirname basename);
|
|
|
|
my $start = getcwd;
|
|
for my $file (@ARGV) {
|
|
chdir $start or die "cannot chdir to $start: $!\n";
|
|
my $dir = dirname ($file);
|
|
my $out = $file;
|
|
unless ($out =~ s/\.in\z//) {
|
|
die "input file $file does not end in .in\n";
|
|
}
|
|
open (FILE, '<', $file) or die "cannot open $file: $!\n";
|
|
open (OUT, '>', $out) or die "cannot open $out: $!\n";
|
|
chdir $dir or die "cannot chdir to $dir: $!\n";
|
|
local $/ = '';
|
|
local $_;
|
|
while (<FILE>) {
|
|
if (/^=include\s+(\S+)/) {
|
|
open (INCLUDE, '<', $1) or die "cannot open $1: $!\n";
|
|
local $/;
|
|
print OUT <INCLUDE> or die "cannot read/write from $1: $!\n";
|
|
close INCLUDE or die "cannot read from $1: $!\n";
|
|
print OUT "\n" or die "cannot write to $out: $!\n";
|
|
} else {
|
|
print OUT $_ or die "cannot write to $out: $!\n";
|
|
}
|
|
}
|
|
close OUT or die "cannot write to $out: $!\n";
|
|
close FILE or die "cannot read from $file\n";
|
|
}
|