From 7ba22721e544d4f02172ffa59cc7ebc7a27c1ddf Mon Sep 17 00:00:00 2001 From: Masayuki Igawa Date: Thu, 31 May 2018 11:31:02 +0900 Subject: [PATCH] Use inline literal markup for options in releasenotes This commit makes the releasenotes to use 'inline literal markup[0] because it would be accurate rendering for commandline options. Otherwise, dashes are changed into an en/em dash entity. And this commit also fixes some inline literal markups which I noticed. Ideally, we should fix like that things in one patch. However, it's a bit hard to find them all.. [0] http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#roles Change-Id: I8f7691b3ff40ccde051620f44217dab244d76960 --- ....0-add-content-type-without-spaces-b2c9b91b257814f3.yaml | 2 +- ...0.0-add-tempest-run-combine-option-e94c1049ba8985d5.yaml | 6 +++--- ...llow_port_security_disabled-option-d0ffaeb2e7817707.yaml | 4 ++-- ...e-validation-config-options-part-2-5cd17b6e0e6cb8a3.yaml | 2 +- releasenotes/notes/add-load-list-cmd-35a4a2e6ea0a36fd.yaml | 4 ++-- .../notes/add-save-state-option-5ea67858cbaca969.yaml | 3 ++- releasenotes/notes/cli-tests-v3fixes-fb38189cefd64213.yaml | 6 +++--- .../notes/tempest-run-fix-updates-564b41706decbba1.yaml | 4 ++-- ...workspace-delete-directory-feature-74d6d157a5a05561.yaml | 2 +- 9 files changed, 17 insertions(+), 16 deletions(-) diff --git a/releasenotes/notes/16/16.0.0-add-content-type-without-spaces-b2c9b91b257814f3.yaml b/releasenotes/notes/16/16.0.0-add-content-type-without-spaces-b2c9b91b257814f3.yaml index fc061bc4f6..9ae46fd10e 100644 --- a/releasenotes/notes/16/16.0.0-add-content-type-without-spaces-b2c9b91b257814f3.yaml +++ b/releasenotes/notes/16/16.0.0-add-content-type-without-spaces-b2c9b91b257814f3.yaml @@ -6,4 +6,4 @@ upgrade: The lack of these additional content-type will cause defcore test to fail for OpenStack public cloud which uses tomcat module in the api gateway. The additions are ``application/json;charset=utf-8``, - ``text/html;charset=utf-8``,``text/plain;charset=utf-8`` \ No newline at end of file + ``text/html;charset=utf-8``, ``text/plain;charset=utf-8`` diff --git a/releasenotes/notes/16/16.0.0-add-tempest-run-combine-option-e94c1049ba8985d5.yaml b/releasenotes/notes/16/16.0.0-add-tempest-run-combine-option-e94c1049ba8985d5.yaml index 73900ca60d..e9c36946f0 100644 --- a/releasenotes/notes/16/16.0.0-add-tempest-run-combine-option-e94c1049ba8985d5.yaml +++ b/releasenotes/notes/16/16.0.0-add-tempest-run-combine-option-e94c1049ba8985d5.yaml @@ -1,6 +1,6 @@ --- features: - | - Adds a new cli option to tempest run, --combine, which is used to indicate - you want the subunit stream output combined with the previous run's in - the testr repository + Adds a new cli option to tempest run, ``--combine``, which is used + to indicate you want the subunit stream output combined with the + previous run's in the testr repository diff --git a/releasenotes/notes/16/16.0.0-remove-deprecated-allow_port_security_disabled-option-d0ffaeb2e7817707.yaml b/releasenotes/notes/16/16.0.0-remove-deprecated-allow_port_security_disabled-option-d0ffaeb2e7817707.yaml index 9d7102fe08..5b4a96d838 100644 --- a/releasenotes/notes/16/16.0.0-remove-deprecated-allow_port_security_disabled-option-d0ffaeb2e7817707.yaml +++ b/releasenotes/notes/16/16.0.0-remove-deprecated-allow_port_security_disabled-option-d0ffaeb2e7817707.yaml @@ -1,5 +1,5 @@ --- upgrade: - | - The deprecated config option 'allow_port_security_disabled' from compute_feature_enabled - group has been removed. + The deprecated config option ``allow_port_security_disabled`` from + ``compute_feature_enabled`` group has been removed. diff --git a/releasenotes/notes/16/16.0.0-remove-deprecated-compute-validation-config-options-part-2-5cd17b6e0e6cb8a3.yaml b/releasenotes/notes/16/16.0.0-remove-deprecated-compute-validation-config-options-part-2-5cd17b6e0e6cb8a3.yaml index b4e4dd1052..c8b0ca85e3 100644 --- a/releasenotes/notes/16/16.0.0-remove-deprecated-compute-validation-config-options-part-2-5cd17b6e0e6cb8a3.yaml +++ b/releasenotes/notes/16/16.0.0-remove-deprecated-compute-validation-config-options-part-2-5cd17b6e0e6cb8a3.yaml @@ -8,4 +8,4 @@ upgrade: - ``compute.ssh_user`` (available as ``validation.image_ssh_user``) - ``scenario.ssh_user`` (available as ``validation.image_ssh_user``) - ``compute.network_for_ssh`` (available as ``validation.network_for_ssh``) - - ``compute.ping_timeout `` (available as ``validation.ping_timeout``) + - ``compute.ping_timeout`` (available as ``validation.ping_timeout``) diff --git a/releasenotes/notes/add-load-list-cmd-35a4a2e6ea0a36fd.yaml b/releasenotes/notes/add-load-list-cmd-35a4a2e6ea0a36fd.yaml index 403bbada28..145e7dd38c 100644 --- a/releasenotes/notes/add-load-list-cmd-35a4a2e6ea0a36fd.yaml +++ b/releasenotes/notes/add-load-list-cmd-35a4a2e6ea0a36fd.yaml @@ -1,7 +1,7 @@ --- features: - | - Adds a new cli option to tempest run, --load-list + Adds a new cli option to tempest run, ``--load-list `` to specify target tests to run from a list-file. The list-file - supports the output format of the tempest run --list-tests + supports the output format of the tempest run ``--list-tests`` command. diff --git a/releasenotes/notes/add-save-state-option-5ea67858cbaca969.yaml b/releasenotes/notes/add-save-state-option-5ea67858cbaca969.yaml index 8fdf4f00ac..abd2610e08 100644 --- a/releasenotes/notes/add-save-state-option-5ea67858cbaca969.yaml +++ b/releasenotes/notes/add-save-state-option-5ea67858cbaca969.yaml @@ -1,4 +1,5 @@ --- features: - | - Add --save-state option to allow saving state of cloud before tempest run. + Add ``--save-state`` option to allow saving state of cloud before + tempest run. diff --git a/releasenotes/notes/cli-tests-v3fixes-fb38189cefd64213.yaml b/releasenotes/notes/cli-tests-v3fixes-fb38189cefd64213.yaml index e3443c8a2c..2a0a86c5dd 100644 --- a/releasenotes/notes/cli-tests-v3fixes-fb38189cefd64213.yaml +++ b/releasenotes/notes/cli-tests-v3fixes-fb38189cefd64213.yaml @@ -2,8 +2,8 @@ other: - | The CLIClient class, when it calls a command line client, uses - --os-project-name instead of --os-tenant-name for the project, and - passes --os-identity-api-version (default empty). + ``--os-project-name`` instead of ``--os-tenant-name`` for the + project, and passes ``--os-identity-api-version`` (default empty). All CLI clients still available in supported releases of OpenStack - which are wrapped by the cmd_with_auth() method support those + which are wrapped by the ``cmd_with_auth()`` method support those switches. diff --git a/releasenotes/notes/tempest-run-fix-updates-564b41706decbba1.yaml b/releasenotes/notes/tempest-run-fix-updates-564b41706decbba1.yaml index 265853d2ef..0f9a0f6bec 100644 --- a/releasenotes/notes/tempest-run-fix-updates-564b41706decbba1.yaml +++ b/releasenotes/notes/tempest-run-fix-updates-564b41706decbba1.yaml @@ -1,8 +1,8 @@ --- features: - | - Adds a new CLI arg in tempest run, --black-regex, which is a regex to - exclude the tests that match it. + Adds a new CLI arg in tempest run, ``--black-regex``, which is a + regex to exclude the tests that match it. fixes: - | Fixes tempest run CLI args mutually exclusive behavior which should not diff --git a/releasenotes/notes/tempest-workspace-delete-directory-feature-74d6d157a5a05561.yaml b/releasenotes/notes/tempest-workspace-delete-directory-feature-74d6d157a5a05561.yaml index ec21098fda..c69ed50422 100644 --- a/releasenotes/notes/tempest-workspace-delete-directory-feature-74d6d157a5a05561.yaml +++ b/releasenotes/notes/tempest-workspace-delete-directory-feature-74d6d157a5a05561.yaml @@ -1,5 +1,5 @@ --- features: - | - Added tempest workspace remove --name --rmdir + Added tempest workspace remove ``--name --rmdir`` feature to delete the workspace directory as well as entry.