db/pgbackrest
1
0
Fork 0
mirror of https://github.com/pgbackrest/pgbackrest.git synced 2025-01-18 04:58:51 +02:00
Code Issues Releases Activity

Add cmd-description tag.

Browse Source 
Allow command summaries to be inserted anywhere in the documentation to avoid duplication.
This commit is contained in:
David Steele 2016-06-12 09:01:56 -04:00
parent f1e92804ce
commit 7c9eaf7210
4 changed files with 38 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/lib/BackRestDoc/Html/DocHtmlPage.pm
View File

@ -361,7 +361,22 @@ sub sectionProcess
if (!defined($oDescription))
{
confess &log(ERROR, "unable to find ${strOption} option in sections - try adding command?");
confess &log(ERROR, "unable to find ${strOption} option in sections - try adding option?");
}
$oSectionBodyElement->
addNew(HTML_DIV, 'section-body-text',
{strContent => $self->processText($oDescription)});
}
# Add cmd descriptive text
elsif ($oChild->nameGet() eq 'cmd-description')
{
my $strCommand = $oChild->paramGet("key");
my $oDescription = ${$self->{oReference}->{oConfigHash}}{&CONFIG_HELP_COMMAND}{$strCommand}{&CONFIG_HELP_DESCRIPTION};
if (!defined($oDescription))
{
confess &log(ERROR, "unable to find ${strCommand} command in sections - try adding command?");
}
$oSectionBodyElement->

15
doc/lib/BackRestDoc/Latex/DocLatexSection.pm
View File

@ -312,7 +312,20 @@ sub sectionProcess
if (!defined($oDescription))
{
confess &log(ERROR, "unable to find ${strOption} option in sections - try adding command?");
confess &log(ERROR, "unable to find ${strOption} option in sections - try adding option?");
}
$strLatex .= "\n" . $self->processText($oDescription) . "\n";
}
# Add cmd descriptive text
elsif ($oChild->nameGet() eq 'cmd-description')
{
my $strCommand = $oChild->paramGet("key");
my $oDescription = ${$self->{oReference}->{oConfigHash}}{&CONFIG_HELP_COMMAND}{$strCommand}{&CONFIG_HELP_DESCRIPTION};
if (!defined($oDescription))
{
confess &log(ERROR, "unable to find ${strCommand} command in sections - try adding command?");
}
$strLatex .= "\n" . $self->processText($oDescription) . "\n";

6
doc/xml/dtd/doc.dtd
View File

@ -106,8 +106,12 @@
<!ELEMENT option-description EMPTY>
<!ATTLIST option-description key CDATA #REQUIRED>
<!ELEMENT cmd-description EMPTY>
<!ATTLIST cmd-description key CDATA #REQUIRED>
<!ELEMENT section (title,
((p|list|table|host-add|execute-list|backrest-config|postgres-config|option-description|code-block)+|
((p|list|table|host-add|execute-list|backrest-config|postgres-config|cmd-description|
option-description|code-block)+|
((p|list)*, section+)|(p|list)*))>
<!ATTLIST section id CDATA #REQUIRED>
<!ATTLIST section keyword CDATA "">

3
doc/xml/release.xml
View File

@ -100,6 +100,9 @@
<release-item>
<p>Allow hidden options to be added to a command. This allows certain commands (like <id>apt-get</id>) to be forced during the build without making that a part of the documentation.</p>
</release-item>
<release-item>
<p>Allow command summaries to be inserted anywhere in the documentation to avoid duplication.</p>
</release-item>
<release-item>
<p>Update TeX Live to 2016 version.</p>
</release-item>