Fix pod2rst output.

bin/pt-archiver

@@ -4428,11 +4428,11 @@ whether known or unknown, of using this tool.  The two main categories of risks
 are those created by the nature of the tool (e.g. read-only tools vs. read-write
 tools) and those created by bugs.
 
-pt-achiver is a read-write tool.  It deletes data from the source by default, so
+pt-archiver is a read-write tool.  It deletes data from the source by default,
-you should test your archiving jobs with the L<"--dry-run"> option if you're not
+so you should test your archiving jobs with the L<"--dry-run"> option if
-sure about them.  It is designed to have as little impact on production systems
+you're not sure about them.  It is designed to have as little impact on
-as possible, but tuning with L<"--limit">, L<"--txn-size"> and similar options
+production systems as possible, but tuning with L<"--limit">, L<"--txn-size">
-might be a good idea too.
+and similar options might be a good idea too.
 
 If you write or use L<"--plugin"> modules, you should ensure they are good
 quality and well-tested. 

util/fix-pod2rst-output

@@ -0,0 +1,68 @@
+#!/usr/bin/env perl
+
+use strict;
+use warnings FATAL => 'all';
+use English qw(-no_match_vars);
+use constant PTDEBUG => $ENV{PTDEBUG} || 0;
+
+my $file = shift @ARGV;
+die "I need a file" unless $file;
+die "$file is not a file" unless -f $file;
+open my $fh, '<', $file or die "Cannot open $file: $OS_ERROR";
+
+my $tool = shift @ARGV;
+die "I need a tool" unless $tool;
+
+print ".. program:: $tool\n\n",
+      ('=' x (length($tool) + 11)), "\n",
+      ":program:`$tool`\n",
+      ('=' x (length($tool) + 11)), "\n\n";
+
+$INPUT_RECORD_SEPARATOR = '';
+
+my $in_code_block = 0;
+my $section       = '';
+
+while (my $para = <$fh>) {
+   next if $para =~ m/^\.\. highlight:: perl/;
+
+   $in_code_block = $para =~ m/^\s{2,}/ ? 1 : 0;
+
+   if ($para =~ m/^\*{2,}\n([\w\s,-]+)\n\*{2,}$/m) {
+      print "$1\n",
+            ('=' x length $1),
+            "\n\n";
+      $section = $1;
+   }
+   elsif ($para =~ m/^Usage: /) {
+      $para =~ s/^Usage: //;
+      print "Usage\n",
+            "-----\n\n",
+            "::\n\n",
+            "  $para";
+   }
+   elsif ($para =~ m/^Examples:/) {
+      print "Examples\n",
+            "--------\n\n";
+   }
+   else {
+      $para =~ s/\.\. code-block:: perl/.. code-block:: bash/mg;
+      $para =~ s/`+$tool`+/$tool/g;
+      $para =~ s/([^\/])$tool/$1:program:`$tool`/g unless $in_code_block;
+      $para =~ s/^$tool/:program:`$tool`/gm;
+      $para =~ s/^--(\S+)$/.. option:: --$1/mg;
+      $para =~ s/"--(\S+)"/:option:`--$1`/g;
+      $para =~ s/\\\*/*/g;
+      $para =~ s/\\ //g;
+      $para =~ s/^[ ]+$//mg;
+      $para =~ s/^\n\n/\n/mg;
+      $para =~ s/code-block:: bash(\s+)CREATE/code-block:: sql$1CREATE/sg;
+      if ( ($section || '') eq 'OUTPUT' ) {
+         $para =~ s/^([A-Z_]+)\n\n/$1\n/;
+      }
+      print $para;
+   }
+}
+
+close $fh;
+exit;

util/write-user-docs

@@ -72,12 +72,16 @@ write_rst() {
    fi
    local tool=$(basename $file)
 
-   cat $file | pod2rst --title=$tool > $RST_DIR/$tool.rst
+   cat $file | pod2rst > $RST_DIR/$tool.orig.rst
    if [ $? -eq 0 ]; then
+      $BRANCH/util/fix-pod2rst-output $RST_DIR/$tool.orig.rst $tool \
+         > $RST_DIR/$tool.rst
       echo "Wrote $RST_DIR/$tool.rst"
    else
       warn "Error writing $RST_DIR/tool.rst"
    fi
+
+   rm $RST_DIR/$tool.orig.rst
 }
 
 # Parse the head1 sections from percona-toolkit.pod and write them as