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

Update stanza-create --force documentation to urge caution when using.

Browse Source 
Suggested by Jason O'Donnell.
This commit is contained in:
David Steele 2018-01-31 17:34:27 -05:00
parent bacc08792d
commit b4d434b41c
3 changed files with 19 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/xml/reference.xml
View File

@ -1158,7 +1158,9 @@
<option id="force" name="Force">
<summary>Force stanza creation.</summary>
<text>If the required stanza information does 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><b>Caution</b>: 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.
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>
<example>n</example>
</option>

10
doc/xml/release.xml
View File

@ -137,6 +137,16 @@
</release-item>
</release-feature-list>
<release-improvement-list>
<release-item>
<release-item-contributor-list>
<release-item-ideator id="odonnell.jason"/>
</release-item-contributor-list>
<p>Update <cmd>stanza-create --force</cmd> documentation to urge caution when using.</p>
</release-item>
</release-improvement-list>
<release-development-list>
<release-item>
<p>Add coding standards document.</p>

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

@ -1516,10 +1516,12 @@ ConfigDefineOptionData configDefineOptionData[] = CFGDEFDATA_OPTION_LIST
CFGDEFDATA_OPTION_OPTIONAL_HELP_SUMMARY("Force stanza creation.")
CFGDEFDATA_OPTION_OPTIONAL_HELP_DESCRIPTION
(
"If the required stanza information does 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."
"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."
)
)