From 9d917cc1cf09e04a26abb4e48dde75665bf4da50 Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <tkajinam@redhat.com>
Date: Sun, 13 Feb 2022 11:36:42 +0900
Subject: [PATCH] Fix description of orchestrator parameters

- coordination_url is not driver URL but backend URL. Driver is
  determined according to the backend.

- The parameter description should not use abbreviations, as these
  can confuse users.

Change-Id: I16eb47e161ae826393d113082091c292d097fc03
---
 cloudkitty/orchestrator.py                | 7 ++++---
 doc/source/_static/cloudkitty.conf.sample | 8 ++++----
 2 files changed, 8 insertions(+), 7 deletions(-)

diff --git a/cloudkitty/orchestrator.py b/cloudkitty/orchestrator.py
index 8fff469d..1087c7df 100644
--- a/cloudkitty/orchestrator.py
+++ b/cloudkitty/orchestrator.py
@@ -51,14 +51,15 @@ orchestrator_opts = [
     cfg.StrOpt(
         'coordination_url',
         secret=True,
-        help='Coordination driver URL',
+        help='Coordination backend URL',
         default='file:///var/lib/cloudkitty/locks'),
     cfg.IntOpt(
         'max_workers',
         default=multiprocessing.cpu_count(),
         sample_default=4,
         min=1,
-        help='Max nb of workers to run. Defaults to the nb of available CPUs'),
+        help='Maximal number of workers to run. Defaults to the number of '
+        'available CPUs'),
     cfg.IntOpt('max_threads',
                # NOTE(peschk_l): This is the futurist default
                default=multiprocessing.cpu_count() * 5,
@@ -67,7 +68,7 @@ orchestrator_opts = [
                deprecated_name='max_greenthreads',
                advanced=True,
                help='Maximal number of threads to use per worker. Defaults to '
-               '5 times the nb of available CPUs'),
+               '5 times the number of available CPUs'),
 ]
 
 CONF.register_opts(orchestrator_opts, group='orchestrator')
diff --git a/doc/source/_static/cloudkitty.conf.sample b/doc/source/_static/cloudkitty.conf.sample
index 498aa711..fff95428 100644
--- a/doc/source/_static/cloudkitty.conf.sample
+++ b/doc/source/_static/cloudkitty.conf.sample
@@ -750,11 +750,11 @@
 # From cloudkitty.common.config
 #
 
-# Coordination driver URL (string value)
+# Coordination backend URL (string value)
 #coordination_url = file:///var/lib/cloudkitty/locks
 
-# Max nb of workers to run. Defaults to the nb of available CPUs
-# (integer value)
+# Maximal number of workers to run. Defaults to the number of
+# available CPUs (integer value)
 # Minimum value: 1
 #
 # This option has a sample default set, which means that
@@ -763,7 +763,7 @@
 #max_workers = 4
 
 # Maximal number of threads to use per worker. Defaults to 5 times the
-# nb of available CPUs (integer value)
+# number of available CPUs (integer value)
 # Minimum value: 1
 # Deprecated group/name - [orchestrator]/max_greenthreads
 # Advanced Option: intended for advanced users and not used