1
0
mirror of https://github.com/pgbackrest/pgbackrest.git synced 2024-12-12 10:04:14 +02:00

Remove references to the C library being optional.

This commit is contained in:
David Steele 2018-03-05 10:03:10 -05:00
parent c07aa2ae19
commit a50b1eb5be
4 changed files with 13 additions and 5 deletions

View File

@ -484,7 +484,7 @@
<config-key id="checksum-page" name="Page Checksums">
<summary>Validate data page checksums.</summary>
<text>Directs <backrest/> to validate all data page checksums while backing up a cluster. This option will be automatically enabled when the required C library is present and checksums are enabled on the cluster.
<text>Directs <backrest/> to validate all data page checksums while backing up a cluster. This option is automatically enabled when data page checksums are enabled on the cluster.
Failures in checksum validation will not abort a backup. Rather, warnings will be emitted in the log (and to the console with default settings) and the list of invalid pages will be stored in the backup manifest.</text>

View File

@ -43,6 +43,14 @@
</release-development-list>
</release-core-list>
<release-doc-list>
<release-improvement-list>
<release-item>
<p>Remove references to the C library being optional.</p>
</release-item>
</release-improvement-list>
</release-doc-list>
<release-test-list>
<release-feature-list>
<release-item>

View File

@ -289,7 +289,7 @@
</execute-list>
<!-- LibC installation -->
<p><backrest/> includes a companion C library that enhances performance and enables the `checksum-page` option and encryption. Pre-built packages are generally a better option than building the C library manually but the steps required are given below for completeness. Depending on the distribution a number of packages may be required which will not be enumerated here.</p>
<p><backrest/> requires a companion C library that enhances performance and enables the `checksum-page` option and encryption. Pre-built packages are generally a better option than building the C library manually but the steps required are given below for completeness. Depending on the distribution a number of packages may be required which will not be enumerated here.</p>
<execute-list host="{[br-install-host]}">
<title>Build and Install C Library</title>
@ -630,7 +630,7 @@
<section id="configure-encryption">
<title>Configure Repository Encryption</title>
<p>The repository will be configured with a cipher type and key to demonstrate encryption. The companion C library is required for encryption, see <link section="/installation">Installation</link>.</p>
<p>The repository will be configured with a cipher type and key to demonstrate encryption.</p>
<p>It is important to use a long, random passphrase for the cipher key. A good way to generate one is to run: <code>openssl rand -base64 48</code>.</p>

View File

@ -519,8 +519,8 @@ static ConfigDefineOptionData configDefineOptionData[] = CFGDEFDATA_OPTION_LIST
CFGDEFDATA_OPTION_HELP_SUMMARY("Validate data page checksums.")
CFGDEFDATA_OPTION_HELP_DESCRIPTION
(
"Directs pgBackRest to validate all data page checksums while backing up a cluster. This option will be automatically "
"enabled when the required C library is present and checksums are enabled on the cluster.\n"
"Directs pgBackRest to validate all data page checksums while backing up a cluster. This option is automatically "
"enabled when data page checksums are enabled on the cluster.\n"
"\n"
"Failures in checksum validation will not abort a backup. Rather, warnings will be emitted in the log (and to the "
"console with default settings) and the list of invalid pages will be stored in the backup manifest."