db/pgbackrest
1
0
Fork 0
mirror of https://github.com/pgbackrest/pgbackrest.git synced 2025-01-18 04:58:51 +02:00
Code Issues Releases Activity

Remove --force option from stanza-create documentation.

Browse Source 
This should have been removed when the support for the option was removed in c7333190.

The option cannot be removed entirely because we don't want to error in the case where --force was specified but the stanza is valid.
This commit is contained in:
David Steele 2019-11-19 15:56:13 -05:00
parent c5ee56a724
commit 5f03471445
3 changed files with 3 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
build/lib/pgBackRestBuild/Config/Data.pm
View File

@ -789,6 +789,7 @@ my %hConfigDefine =
&CFGCMD_STANZA_CREATE =>
{
&CFGDEF_DEFAULT => false,
&CFGDEF_INTERNAL => true,
},
&CFGCMD_STANZA_DELETE =>

2
doc/xml/reference.xml
View File

@ -1329,7 +1329,7 @@
<option id="force" name="Force">
<summary>Force stanza creation.</summary>
<text><admonition type="caution">Use <br-option>--force</br-option> only as a last resort, when all else fails. If data is missing from the repository then the recreated <file>.info</file> files will likely be corrupt.</admonition>If the required stanza <file>.info</file> files do not exist in the repository but backups or WAL segments do exist, then this option can be used to force the stanza to be created from the existing data in the repository. This is most likely to be useful after corruption or an incomplete restore of the repository from elsewhere.</text>
<text>This option is no longer supported.</text>
<example>n</example>
</option>

12
src/config/define.auto.c
View File

@ -1219,17 +1219,7 @@ static ConfigDefineOptionData configDefineOptionData[] = CFGDEFDATA_OPTION_LIST
CFGDEFDATA_OPTION_OPTIONAL_COMMAND(cfgDefCmdStanzaCreate)
CFGDEFDATA_OPTION_OPTIONAL_DEFAULT("0")
CFGDEFDATA_OPTION_OPTIONAL_HELP_SUMMARY("Force stanza creation.")
CFGDEFDATA_OPTION_OPTIONAL_HELP_DESCRIPTION
(
"CAUTION: Use --force only as a last resort, when all else fails. If data is missing from the repository then "
"the recreated .info files will likely be corrupt.\n"
"\n"
"If the required stanza .info files do not exist in the repository but backups or WAL segments do exist, then "
"this option can be used to force the stanza to be created from the existing data in the repository. This "
"is most likely to be useful after corruption or an incomplete restore of the repository from elsewhere."
)
CFGDEFDATA_OPTION_OPTIONAL_INTERNAL(true)
)
CFGDEFDATA_OPTION_OPTIONAL_COMMAND_OVERRIDE