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

Skip command-line options in configuration reference.

Browse Source 
Options that are only valid on the command-line should not appear in the configuration reference because it implies that they can be added to pgbackrest.conf, which is not the case.

Most command-line options were already excluded because they lacked a section, but a few were slipping through.
This commit is contained in:
David Steele 2024-09-20 15:21:38 +03:00
parent b19134dccd
commit f73c638275
2 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -177,9 +177,14 @@ referenceConfigurationRender(const BldCfg *const bldCfg, const BldHlp *const bld
const BldCfgOption *const optCfg = lstFind(bldCfg->optList, &optHlp->name);
ASSERT(optCfg != NULL);
// Skip if option does not belong in this section
if (!strEq(optHlp->section == NULL ? STRDEF("general") : optHlp->section, section->id))
continue;
// Skip if option is command-line only
if (strEq(optCfg->section, SECTION_COMMAND_LINE_STR))
continue;
// Skip if option is internal
if (optCfg->internal)
continue;

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

@ -258,11 +258,6 @@ testRun(void)
"example: buffer-size=128KiB\n"
"example: buffer-size=256KiB</code-block>"
"</section>"
"<section id=\"option-config\">"
"<title>Config Option (<id>--config</id>)</title>"
"<p>config option summary.</p>"
"<p>config option description.</p>"
"</section>"
"<section id=\"option-secure\">"
"<title>Secure Option (<id>--secure</id>)</title>"
"<p>Secure option summary.</p>"