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

Rename db-* options to pg-* and backup-* options to repo-* to improve consistency.

Browse Source 
* repo-* options are now indexed although only one is allowed.
* List deprecated option names in documentation and command-line help.
This commit is contained in:
David Steele
2018-02-03 18:27:38 -05:00
parent dc73abdb6e
commit be90028100
96 changed files with 5383 additions and 4270 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
src/command/help/help.c
View File

@@ -255,12 +255,17 @@ helpRender()
// Ensure the option is valid
const char *optionName = strPtr(strLstGet(cfgCommandParam(), 0));
ConfigOption optionId = cfgOptionId(optionName);
if (cfgOptionId(optionName) == -1)
THROW(OptionInvalidError, "option '%s' is not valid for command '%s'", optionName, commandName);
{
if (cfgDefOptionId(optionName) != -1)
optionId = cfgOptionIdFromDefId(cfgDefOptionId(optionName), 0);
else
THROW(OptionInvalidError, "option '%s' is not valid for command '%s'", optionName, commandName);
}
// Output option summary and description
ConfigOption optionId = cfgOptionId(optionName);
ConfigDefineOption optionDefId = cfgOptionDefIdFromId(optionId);
strCatFmt(
@@ -291,6 +296,27 @@ helpRender()
if (defaultValue != NULL)
strCatFmt(result, "default: %s\n", strPtr(defaultValue));
}
// Output alternate names (call them deprecated so the user will know not to use them)
if (cfgDefOptionHelpNameAlt(optionDefId))
{
strCat(result, "\ndeprecated name");
if (cfgDefOptionHelpNameAltValueTotal(optionDefId) > 1)
strCat(result, "s"); // {uncovered - no option has more than one alt name}
strCat(result, ": ");
for (int nameAltIdx = 0; nameAltIdx < cfgDefOptionHelpNameAltValueTotal(optionDefId); nameAltIdx++)
{
if (nameAltIdx != 0)
strCat(result, ", "); // {uncovered - no option has more than one alt name}
strCat(result, cfgDefOptionHelpNameAltValue(optionDefId, nameAltIdx));
}
strCat(result, "\n");
}
}
}