Skip to content

Conversation

@richsalz
Copy link
Contributor

This moves the manpages in the doc directory into standard manX directories.
Once merged, bin/mk-manpages in www repo will need to be updated.

@richsalz richsalz added the branch: master Applies to master branch label Oct 21, 2016
@richsalz richsalz self-assigned this Oct 21, 2016
@levitte
Copy link
Member

levitte commented Oct 21, 2016

Considering you have one commit starting with WIP:, perhaps this PR should be marked accordingly?

@richsalz
Copy link
Contributor Author

i'll merge/squash and remove the WIP. it's not a WIP any more.

@levitte
Copy link
Member

levitte commented Oct 21, 2016

Add this patch as well, that covers docs production on Windows and VMS:

diff --git a/util/process_docs.pl b/util/process_docs.pl
index 8b8de81..2c54f02 100644
--- a/util/process_docs.pl
+++ b/util/process_docs.pl
@@ -28,26 +28,23 @@ 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}
@@ -62,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};
@@ -75,8 +72,8 @@ 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");

@richsalz
Copy link
Contributor Author

great, merged your diff. thanks!

@richsalz
Copy link
Contributor Author

rebased and push -f'd

@levitte
Copy link
Member

levitte commented Oct 21, 2016

Grand. Now, we wait for the CIs to be done.

@levitte
Copy link
Member

levitte commented Oct 21, 2016

Darnit... with the GH hickup, it seems we don't get an appveyor build on this unless something new is pushed... Meh...

@levitte
Copy link
Member

levitte commented Oct 21, 2016

I just tested on VMS, works beautifully.

Re the commits, I assume you're going to squash them all into one?

@levitte levitte added the approval: done This pull request has the required number of approvals label Oct 21, 2016
@richsalz
Copy link
Contributor Author

Yes, squash into one.
Need to prototype the web mk-manpages change first I think, so that the website still works....

@richsalz
Copy link
Contributor Author

Just did a force update, changed the commit message.

@richsalz
Copy link
Contributor Author

done, and did a quick hack for the website. thanks!

@richsalz richsalz closed this Oct 26, 2016
@richsalz richsalz deleted the mv-manpages branch October 26, 2016 18:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approval: done This pull request has the required number of approvals branch: master Applies to master branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants