percona/percona-toolkit
1
0
Fork 0
mirror of https://github.com/percona/percona-toolkit.git synced 2025-09-13 14:39:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merged fix-927955-898665-pod2rst-issues & add a function in write-user-docs to fix the html that comes from sphinx, to really fix 898665

Browse Source
This commit is contained in:
Brian Fraser fraserb@gmail.com
2012-12-06 14:57:16 -03:00
parent 4eaf6e51f8 611e5b6eec
commit 48442bd5a0
3 changed files with 142 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
util/write-user-docs
View File

@@ -1,5 +1,7 @@
#!/usr/bin/env bash
#set -x
# Usage: write-user-docs [TOOLS]
#
# This script writes/updates the user documentation. User docs come from
@@ -64,24 +66,37 @@ RST_DIR=$DOCS_DIR/user
# Subroutines
# ############################################################################
fix_html () {
local name="$1"
perl -MFile::Basename=basename -MFile::Slurp=read_file,write_file -le '
my $f = shift;
my $tool = basename($f);
$tool =~ s/\.html//;
my $out = read_file($f);
$out =~ s{
\Q<dt id="\E(cmdoption-$tool--)\Q">\E\s*
\Q<tt class="descname">--</tt><tt class="descclassname">\E([^<]+)
\Q</tt><a class="headerlink" href="\E[^"]+"
}{<dt id="$1$2">
<tt class="descname">--$2</tt><tt class="descclassname"></tt><a class="headerlink" href="#$1$2"}xg;
write_file($f, $out);
' $RST_DIR/html/$name.html
}
write_rst() {
local file="$1"
local tool="$(basename $1)"
if [ ! -f $file ]; then
warn "$file does not exist"
return
fi
local tool=$(basename $file)
cat $file | pod2rst > $RST_DIR/$tool.orig.rst
$BRANCH/util/pod2rst-fixed $file > $RST_DIR/$tool.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"
die "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
@@ -150,4 +165,17 @@ if [ $BUILD -eq 1 ]; then
exit_status=$(( exit_status | $? ))
fi
if [ $# -gt 0 ]; then
for tool; do
name="$(basename $tool)"
fix_html $name
done
else
for tool in `ls $BRANCH/bin/*`; do
name="$(basename $tool)"
fix_html $name
done
fi
exit $exit_status