From a50b1eb5be64c0ea68c468cbe0b793be93136c33 Mon Sep 17 00:00:00 2001 From: David Steele Date: Mon, 5 Mar 2018 10:03:10 -0500 Subject: [PATCH] Remove references to the C library being optional. --- doc/xml/reference.xml | 2 +- doc/xml/release.xml | 8 ++++++++ doc/xml/user-guide.xml | 4 ++-- src/config/define.auto.c | 4 ++-- 4 files changed, 13 insertions(+), 5 deletions(-) diff --git a/doc/xml/reference.xml b/doc/xml/reference.xml index be4ec8dfe..cb1160cf1 100644 --- a/doc/xml/reference.xml +++ b/doc/xml/reference.xml @@ -484,7 +484,7 @@ Validate data page checksums. - Directs 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. + Directs 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. diff --git a/doc/xml/release.xml b/doc/xml/release.xml index 655590d3e..75fb83661 100644 --- a/doc/xml/release.xml +++ b/doc/xml/release.xml @@ -43,6 +43,14 @@ + + + +

Remove references to the C library being optional.

+
+
+
+ diff --git a/doc/xml/user-guide.xml b/doc/xml/user-guide.xml index 2145d7cc1..b36dd22ae 100644 --- a/doc/xml/user-guide.xml +++ b/doc/xml/user-guide.xml @@ -289,7 +289,7 @@ -

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.

+

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.

Build and Install C Library @@ -630,7 +630,7 @@
Configure Repository Encryption -

The repository will be configured with a cipher type and key to demonstrate encryption. The companion C library is required for encryption, see Installation.

+

The repository will be configured with a cipher type and key to demonstrate encryption.

It is important to use a long, random passphrase for the cipher key. A good way to generate one is to run: openssl rand -base64 48.

diff --git a/src/config/define.auto.c b/src/config/define.auto.c index 8d10bd8cf..663c64da0 100644 --- a/src/config/define.auto.c +++ b/src/config/define.auto.c @@ -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."