From 39196a4e90f0d46f6b8122b2e421b519b9c6d93f Mon Sep 17 00:00:00 2001
From: Ben Nemec <bnemec@redhat.com>
Date: Tue, 6 Aug 2019 19:00:24 +0000
Subject: [PATCH] Fix nits on kafka compression help text
There is no need to explicitly list the choices in the help text.
The oslo.config sample generator will include the choices automatically[0]
Also tweaks the wording of text to make it clear that it is the allowed
values which vary based on kafka version.
Change-Id: I4116e8871436097dea650f56e7b187358367d92e
0: https://github.com/openstack/oslo.config/blob/2488c1e1cee151a3a65c60f371f0bea2f15d4bca/oslo_config/generator.py#L263
---
oslo_messaging/_drivers/kafka_driver/kafka_options.py | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/oslo_messaging/_drivers/kafka_driver/kafka_options.py b/oslo_messaging/_drivers/kafka_driver/kafka_options.py
index 42c990cd4..c1b8bef71 100644
--- a/oslo_messaging/_drivers/kafka_driver/kafka_options.py
+++ b/oslo_messaging/_drivers/kafka_driver/kafka_options.py
@@ -51,9 +51,9 @@ KAFKA_OPTS = [
cfg.StrOpt('compression_codec', default='none',
choices=['none', 'gzip', 'snappy', 'lz4', 'zstd'],
help='The compression codec for all data generated by the '
- 'producer. Valid values are: gzip, snappy, lz4, zstd. If '
- 'not set, compression will not be used. Note that the '
- 'legal option of this depends on the kafka version'),
+ 'producer. If not set, compression will not be used. '
+ 'Note that the allowed values of this depend on the kafka '
+ 'version'),
cfg.BoolOpt('enable_auto_commit',
default=False,