From 45abea471ecec10a351bfd9e5fbed8737c32da42 Mon Sep 17 00:00:00 2001 From: David Steele Date: Tue, 10 Oct 2023 13:02:50 -0400 Subject: [PATCH] Simplify section titles in configuration reference. 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. --- doc/src/command/build/reference.c | 4 +--- doc/xml/release/2023/2.49.xml | 15 +++++++++++++++ test/src/module/doc/buildTest.c | 2 +- 3 files changed, 17 insertions(+), 4 deletions(-) diff --git a/doc/src/command/build/reference.c b/doc/src/command/build/reference.c index d644a8aaa..6368fb2a3 100644 --- a/doc/src/command/build/reference.c +++ b/doc/src/command/build/reference.c @@ -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++) diff --git a/doc/xml/release/2023/2.49.xml b/doc/xml/release/2023/2.49.xml index dea9a7d97..de71a7126 100644 --- a/doc/xml/release/2023/2.49.xml +++ b/doc/xml/release/2023/2.49.xml @@ -1,2 +1,17 @@ + + + + + + + + + + + +

Build command and configuration reference in C.

+
+
+
diff --git a/test/src/module/doc/buildTest.c b/test/src/module/doc/buildTest.c index 7d3bfd95f..b5ff0a2e6 100644 --- a/test/src/module/doc/buildTest.c +++ b/test/src/module/doc/buildTest.c @@ -219,7 +219,7 @@ testRun(void) "

config text

" "" "
" - "General Options (<id>general</id>)" + "General Options" "

general section

" "
" "Buffer Size Option (<id>--buffer-size</id>)"