X-Git-Url: https://git.openssl.org/?p=openssl.git;a=blobdiff_plain;f=util%2Fprocess_docs.pl;h=edb7ca6e8d3da7ea90bd606ef400c79047863125;hp=efc4ef53616197cbb5815f8d6536cdd032382b9d;hb=38f5c30b311f0e736081e0b64b22e917b651536a;hpb=04b7805a8686d33186ca9e0571355e7fa2ef2d86 diff --git a/util/process_docs.pl b/util/process_docs.pl index efc4ef5361..edb7ca6e8d 100644 --- a/util/process_docs.pl +++ b/util/process_docs.pl @@ -13,35 +13,38 @@ use File::Spec::Functions; use File::Basename; use File::Copy; use File::Path; +use if $^O ne "VMS", 'File::Glob' => qw/glob/; use Getopt::Long; use Pod::Usage; use lib '.'; use configdata; +# We know we are in the 'util' directory and that our perl modules are +# in util/perl +use lib catdir(dirname($0), "perl"); +use OpenSSL::Util::Pod; + my %options = (); GetOptions(\%options, 'sourcedir=s', # Source directory - 'subdir=s%', # Subdirectories to look through, + 'section=i@', # Subdirectories to look through, # with associated section numbers 'destdir=s', # Destination directory #'in=s@', # Explicit files to process (ignores sourcedir) - #'section=i', # Default section used for --in files 'type=s', # The result type, 'man' or 'html' 'remove', # To remove files rather than writing them 'dry-run|n', # Only output file names on STDOUT 'debug|D+', ); -unless ($options{subdir}) { - $options{subdir} = { apps => '1', - crypto => '3', - ssl => '3' }; +unless ($options{section}) { + $options{section} = [ 1, 3, 5, 7 ]; } unless ($options{sourcedir}) { $options{sourcedir} = catdir($config{sourcedir}, "doc"); } -pod2usage(1) unless ( defined $options{subdir} +pod2usage(1) unless ( defined $options{section} && defined $options{sourcedir} && defined $options{destdir} && defined $options{type} @@ -56,8 +59,8 @@ if ($options{debug}) { if defined $options{destdir}; print STDERR "DEBUG: --type = $options{type}\n" if defined $options{type}; - foreach (keys %{$options{subdir}}) { - print STDERR "DEBUG: --subdir = $_=$options{subdir}->{$_}\n"; + foreach (sort @{$options{section}}) { + print STDERR "DEBUG: --section = $_\n"; } print STDERR "DEBUG: --remove = $options{remove}\n" if defined $options{remove}; @@ -69,59 +72,25 @@ if ($options{debug}) { my $symlink_exists = eval { symlink("",""); 1 }; -foreach my $subdir (keys %{$options{subdir}}) { - my $section = $options{subdir}->{$subdir}; +foreach my $section (sort @{$options{section}}) { + my $subdir = "man$section"; my $podsourcedir = catfile($options{sourcedir}, $subdir); - my $podglob = '"'.catfile($podsourcedir, "*.pod").'"'; + my $podglob = catfile($podsourcedir, "*.pod"); foreach my $podfile (glob $podglob) { my $podname = basename($podfile, ".pod"); my $podpath = catfile($podfile); - my %podinfo = ( section => $section ); - - print STDERR "DEBUG: Reading $podpath\n" if $options{debug}; - open my $pod_fh, $podpath or die "Trying to read $podpath: $!\n"; - while (<$pod_fh>) { - s|\R$||; - if (m|^=for\s+comment\s+openssl_manual_section:\s*([0-9])\s*$|) { - print STDERR "DEBUG: Found man section number $1\n" - if $options{debug}; - $podinfo{section} = $1; - } - last if (m|^=head1| - && defined $podinfo{lastsect} - && $podinfo{lastsect} eq "NAME"); - if (m|^=head1\s*(.*)|) { - $podinfo{lastsect} = $1; - $podinfo{lastsect} =~ s/\s+$//; - print STDERR "DEBUG: Found new pod section $1\n" - if $options{debug}; - print STDERR "DEBUG: Clearing pod section text\n" - if $options{debug}; - $podinfo{lastsecttext} = ""; - } - next if (m|^=| || m|^\s*$|); - print STDERR "DEBUG: accumulating pod section text \"$_\"\n" - if $options{debug}; - $podinfo{lastsecttext} .= " " if $podinfo{lastsecttext}; - $podinfo{lastsecttext} .= $_; - } - close $pod_fh; - print STDERR "DEBUG: Done reading $podpath\n" if $options{debug}; - $podinfo{lastsecttext} =~ s| - .*$||; - print STDERR "DEBUG: Done reading $podpath\n" if $options{debug}; - - my @podfiles = - grep { $_ ne $podname } - map { s|\s+||g; $_ } - split(m|,|, $podinfo{lastsecttext}); + my %podinfo = extract_pod_info($podpath, + { debug => $options{debug}, + section => $section }); + my @podfiles = grep { $_ ne $podname } @{$podinfo{names}}; my $updir = updir(); my $name = uc $podname; my $suffix = { man => ".$podinfo{section}", html => ".html" } -> {$options{type}}; my $generate = { man => "pod2man --name=$name --section=$podinfo{section} --center=OpenSSL --release=$config{version} \"$podpath\"", - html => "pod2html \"--podroot=$options{sourcedir}\" --htmldir=$updir --podpath=apps:crypto:ssl \"--infile=$podpath\" \"--title=$podname\"" + html => "pod2html \"--podroot=$options{sourcedir}\" --htmldir=$updir --podpath=man1:man3:man5:man7 \"--infile=$podpath\" \"--title=$podname\"" } -> {$options{type}}; my $output_dir = catdir($options{destdir}, "man$podinfo{section}"); my $output_file = $podname . $suffix; @@ -133,7 +102,7 @@ foreach my $subdir (keys %{$options{subdir}}) { if $options{debug}; unless ($options{"dry-run"}) { @output = `$generate`; - map { s|href="http://man\.he\.net/man|href="../man|g; } @output + map { s|href="http://man\.he\.net/(man\d/[^"]+)(?:\.html)?"|href="../$1.html"|g; } @output if $options{type} eq "html"; } print STDERR "DEBUG: Done processing\n" if $options{debug};