db/pgbackrest
1
0
Fork 0
mirror of https://github.com/pgbackrest/pgbackrest.git synced 2024-12-12 10:04:14 +02:00
Code Issues Releases Activity

Add usage documentation for test.pl.

Browse Source
This commit is contained in:
Cynthia Shang 2016-05-03 16:28:20 -04:00 committed by David Steele
parent 7b030c5173
commit 6cd1c42ddc
1 changed files with 23 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
doc/doc.pl
View File

@ -48,8 +48,17 @@ doc.pl - Generate pgBackRest documentation
doc.pl [options]
General Options:
--help display usage and exit
--help Display usage and exit
--version Display pgBackRest version
--quiet Sets log level to ERROR
--log-level Log level for execution (e.g. ERROR, WARN, INFO, DEBUG)
--no-exe Should commands be executed when building help? (for testing only)
--use-cache Use cached data to generate the docs (for testing textual changes only)
--var Override variables defined in the XML
--doc-path Document path to render (manifest.xml should be located here)
--out Output types (html, pdf, markdown)
--keyword Keyword used to filter output
--require Require only certain sections of the document (to speed testing)
=cut
####################################################################################################################################
@ -60,19 +69,19 @@ use constant OP_MAIN => 'Main';
use constant OP_MAIN_DOC_PROCESS => OP_MAIN . '::docProcess';
####################################################################################################################################
# Load command line parameters and config
# Load command line parameters and config (see usage above for details)
####################################################################################################################################
my $bHelp = false; # Display usage
my $bVersion = false; # Display version
my $bQuiet = false; # Sets log level to ERROR
my $strLogLevel = 'info'; # Log level for tests
my $bNoExe = false; # Should commands be executed when buildng help? (for testing only)
my $bUseCache = false; # Use cached data to generate the docs (for testing code changes only)
my $oVariableOverride = {}; # Override variables
my $strDocPath; # Document path to render
my @stryOutput; # Output types
my @stryKeyword; # Keyword used to filter output
my @stryRequire; # Required sections of the document (to speed testing)
my $bHelp = false;
my $bVersion = false;
my $bQuiet = false;
my $strLogLevel = 'info';
my $bNoExe = false;
my $bUseCache = false;
my $oVariableOverride = {};
my $strDocPath;
my @stryOutput;
my @stryKeyword;
my @stryRequire;
GetOptions ('help' => \$bHelp,
'version' => \$bVersion,