From 333e83b8a48b8bfe8960c45a79ab1661179eea2f Mon Sep 17 00:00:00 2001 From: Sean McGinnis Date: Wed, 10 Apr 2019 12:54:42 -0500 Subject: [PATCH] Use proper casing in backup_compression_algorithm doc Docs were stating to set to "None" to disable compression, but currently that option is case sensitive and needs to be set to "none". Partial-bug: #1823852 Change-Id: I38c6dacf3bd2a750085da4b48ab9dcfc2ecb0b93 Signed-off-by: Sean McGinnis --- cinder/backup/chunkeddriver.py | 2 +- doc/source/admin/blockstorage-volume-backups.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/cinder/backup/chunkeddriver.py b/cinder/backup/chunkeddriver.py index 6ca786b5088..24954465c05 100644 --- a/cinder/backup/chunkeddriver.py +++ b/cinder/backup/chunkeddriver.py @@ -53,7 +53,7 @@ backup_opts = [ choices=['none', 'off', 'no', 'zlib', 'gzip', 'bz2', 'bzip2'], - help='Compression algorithm (None to disable)'), + help='Compression algorithm ("none" to disable)'), ] CONF = cfg.CONF diff --git a/doc/source/admin/blockstorage-volume-backups.rst b/doc/source/admin/blockstorage-volume-backups.rst index 7c778dc487a..00e49837bfb 100644 --- a/doc/source/admin/blockstorage-volume-backups.rst +++ b/doc/source/admin/blockstorage-volume-backups.rst @@ -133,7 +133,7 @@ appropriate for your environment: backup_sha_block_size_bytes = 32768 backup_file_size = 1999994880 -The option ``backup_compression_algorithm`` can be set to ``bz2`` or ``None``. +The option ``backup_compression_algorithm`` can be set to ``bz2`` or ``none``. The latter can be a useful setting when the server providing the share for the backup repository itself performs deduplication or compression on the backup data.