db/pgbackrest
1
0
Fork 0
mirror of https://github.com/pgbackrest/pgbackrest.git synced 2025-03-05 15:05:48 +02:00
Code Issues Releases Activity

Skip internal options in the configuration reference.

Browse Source 
Most internal options were being skipped, but not in the case where an option was marked internal for a specific command.

The command-line help was not affected by this issue.
This commit is contained in:
David Steele 2022-05-31 12:36:21 -04:00
parent f0aae6ceab
commit 2643050be0
2 changed files with 31 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/lib/pgBackRestDoc/Common/DocConfig.pm
View File

@ -320,6 +320,13 @@ sub process
$oCommandOption->{&CONFIG_HELP_INTERNAL} =
cfgDefineCommand()->{$strCommand}{&CFGDEF_INTERNAL} ? true : $oOptionDefine->{$strOption}{&CFGDEF_INTERNAL};
# If internal is defined for the option/command it overrides everthing else
if (defined($oOptionDefine->{$strOption}{&CFGDEF_COMMAND}{$strCommand}{&CFGDEF_INTERNAL}))
{
$oCommandOption->{&CONFIG_HELP_INTERNAL} =
$oOptionDefine->{$strOption}{&CFGDEF_COMMAND}{$strCommand}{&CFGDEF_INTERNAL};
}
$$oCommandOption{&CONFIG_HELP_NAME} = $oOptionDoc->paramGet('name');
# Generate a list of alternate names
@ -445,6 +452,9 @@ sub manGet
if ($$hOption{&CONFIG_HELP_SOURCE} eq CONFIG_HELP_SOURCE_COMMAND)
{
# Skip internal options
next if $hOption->{&CONFIG_HELP_INTERNAL};
$iOptionMaxLen = length($strOption) > $iOptionMaxLen ? length($strOption) : $iOptionMaxLen;
$$hOptionList{$strCommand}{$strOption}{&CONFIG_HELP_SUMMARY} = $$hOption{&CONFIG_HELP_SUMMARY};
@ -714,7 +724,7 @@ sub helpCommandDocGet
foreach my $strOption (sort(keys(%{$$oCommandHash{&CONFIG_HELP_OPTION}})))
{
# Skip internal options
next if $rhConfigDefine->{$strOption}{&CFGDEF_INTERNAL};
next if $$oCommandHash{&CONFIG_HELP_OPTION}{$strOption}{&CONFIG_HELP_INTERNAL};
# Skip secure options that can't be defined on the command line
next if ($rhConfigDefine->{$strOption}{&CFGDEF_SECURE});

20
doc/xml/release.xml
View File

@ -64,6 +64,21 @@
</release-item>
</release-development-list>
</release-core-list>
<release-doc-list>
<release-bug-list>
<release-item>
<github-pull-request id="1749"/>
<release-item-contributor-list>
<release-item-ideator id="francisco.miguel.biete"/>
<release-item-contributor id="david.steele"/>
</release-item-contributor-list>
<p>Skip internal options in the configuration reference.</p>
</release-item>
</release-bug-list>
</release-doc-list>
</release>
<release date="2022-05-16" version="2.39" title="Verify and File Bundling">
@ -11475,6 +11490,11 @@
<contributor-id type="github">fatihmtekin</contributor-id>
</contributor>
<contributor id="francisco.miguel.biete">
<contributor-name-display>Francisco Miguel Biete</contributor-name-display>
<contributor-id type="github">fmbiete</contributor-id>
</contributor>
<contributor id="floris.van.nee">
<contributor-name-display>Floris van Nee</contributor-name-display>
<contributor-id type="github">fvannee</contributor-id>