openstack/nova
Code Issues Proposed changes

docs: update code-review guide for config options

Browse Source 
We recently came to the conclusion that the original idea how the
config options of Nova should be documented are too hard to maintain.
The discussion can be found on the ML starting with:
http://lists.openstack.org/pipermail/openstack-dev/2016-May/095538.html

This change reflects the outcome of the discussion.

Change-Id: I27b2cbb663f3c9a8c2503c3148280a3844f69cdd
This commit is contained in:
Markus Zoeller
2016-08-09 17:35:55 +02:00
parent 4455d00c79
commit c1a30f85d6
1 changed files with 5 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
doc/source/code-review.rst
View File

@@ -139,14 +139,9 @@ A config option should be checked for:
(e.g. timeouts or so) describe the unit which is used (seconds, megabyte,
mebibyte, ...).
* A long description which shows the impact and scope. The operators should
* A long description which explains the impact and scope. The operators should
know the expected change in the behavior of Nova if they tweak this.
* Hints which services will consume this config option. Operators/Deployers
should not be forced to read the code to know which one of the services will
change its behavior nor should they set this in every ``nova.conf`` file to
be sure.
* Descriptions/Validations for the possible values.
* If this is an option with numeric values (int, float), describe the
@@ -155,8 +150,10 @@ A config option should be checked for:
* If this is a StrOpt, list any possible regex validations, or provide a
list of acceptable and/or prohibited values.
* Interdependencies to other options. If other config options have to be
considered when this config option gets changed, is this described?
Previously used sections which explained which services consume a specific
config option and which options are related to each other got dropped
because they are too hard to maintain:
http://lists.openstack.org/pipermail/openstack-dev/2016-May/095538.html
Third Party Tests
=================