db/pgbackrest
1
0
Fork 0
mirror of https://github.com/pgbackrest/pgbackrest.git synced 2025-01-30 05:39:12 +02:00
Code Issues Releases Activity

Simplify section titles in configuration reference.

Browse Source 
For some reason the internal section id was included in the title. This was probably copied from another section title where it made more sense, e.g. including the option name after the title.

Also add release note missed in 1eb01622.
This commit is contained in:
David Steele 2023-10-10 13:02:50 -04:00
parent 1eb0162208
commit 45abea471e
3 changed files with 17 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/src/command/build/reference.c
View File

@ -168,9 +168,7 @@ referenceConfigurationRender(const BldCfg *const bldCfg, const BldHlp *const bld
XmlNode *const xmlSectionTitle = xmlNodeAdd(xmlSection, STRDEF("title"));
xmlNodeAttributeSet(xmlSection, STRDEF("id"), strNewFmt("section-%s", strZ(section->id)));
xmlNodeContentSet(xmlSectionTitle, strNewFmt("%s Options (", strZ(section->name)));
xmlNodeContentSet(xmlNodeAdd(xmlSectionTitle, STRDEF("id")), section->id);
xmlNodeContentSet(xmlSectionTitle, STRDEF(")"));
xmlNodeContentSet(xmlSectionTitle, strNewFmt("%s Options", strZ(section->name)));
xmlNodeChildAdd(xmlNodeAdd(xmlSection, STRDEF("text")), section->introduction);
for (unsigned int optIdx = 0; optIdx < lstSize(bldHlp->optList); optIdx++)

15
doc/xml/release/2023/2.49.xml
View File

@ -1,2 +1,17 @@
<release date="XXXX-XX-XX" version="2.49dev" title="UNDER DEVELOPMENT">
<release-doc-list>
<release-development-list>
<release-item>
<commit subject="Add new XML functions required for building documentation."/>
<commit subject="Remove unused references to DocConfig and DocConfigData Perl modules."/>
<commit subject="Allow documentation source file to be specified in manifest."/>
<commit subject="Parse defaults and text sections in help.xml."/>
<commit subject="Use CSS to number sections in documentation."/>
<commit subject="Build command and configuration reference in C."/>
<commit subject="Simplify section titles in configuration reference."/>
<p>Build command and configuration reference in C.</p>
</release-item>
</release-development-list>
</release-doc-list>
</release>

2
test/src/module/doc/buildTest.c
View File

@ -219,7 +219,7 @@ testRun(void)
"<text><p>config text</p></text>"
"</section>"
"<section id=\"section-general\">"
"<title>General Options (<id>general</id>)</title>"
"<title>General Options</title>"
"<text><p>general section</p></text>"
"<section id=\"option-buffer-size\">"
"<title>Buffer Size Option (<id>--buffer-size</id>)</title>"