diff --git a/doc/lib/BackRestDoc/Html/DocHtmlPage.pm b/doc/lib/BackRestDoc/Html/DocHtmlPage.pm index 74867b7ea..674e64ebc 100644 --- a/doc/lib/BackRestDoc/Html/DocHtmlPage.pm +++ b/doc/lib/BackRestDoc/Html/DocHtmlPage.pm @@ -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-> diff --git a/doc/lib/BackRestDoc/Latex/DocLatexSection.pm b/doc/lib/BackRestDoc/Latex/DocLatexSection.pm index 26687fa23..f0b1734c2 100644 --- a/doc/lib/BackRestDoc/Latex/DocLatexSection.pm +++ b/doc/lib/BackRestDoc/Latex/DocLatexSection.pm @@ -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"; diff --git a/doc/xml/dtd/doc.dtd b/doc/xml/dtd/doc.dtd index c5e15c8c2..4125b172f 100644 --- a/doc/xml/dtd/doc.dtd +++ b/doc/xml/dtd/doc.dtd @@ -106,8 +106,12 @@ + + + diff --git a/doc/xml/release.xml b/doc/xml/release.xml index 03978d877..c2b0ab12a 100644 --- a/doc/xml/release.xml +++ b/doc/xml/release.xml @@ -100,6 +100,9 @@

Allow hidden options to be added to a command. This allows certain commands (like apt-get) to be forced during the build without making that a part of the documentation.

+ +

Allow command summaries to be inserted anywhere in the documentation to avoid duplication.

+

Update TeX Live to 2016 version.