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
This commit is contained in:
Masayuki Igawa 2018-05-31 11:31:02 +09:00
parent ff213a5ce2
commit 7ba22721e5
No known key found for this signature in database
GPG Key ID: 290F53EDC899BF89
9 changed files with 17 additions and 16 deletions

View File

@ -6,4 +6,4 @@ upgrade:
The lack of these additional content-type will cause defcore test The lack of these additional content-type will cause defcore test
to fail for OpenStack public cloud which uses tomcat module in the to fail for OpenStack public cloud which uses tomcat module in the
api gateway. The additions are ``application/json;charset=utf-8``, api gateway. The additions are ``application/json;charset=utf-8``,
``text/html;charset=utf-8``,``text/plain;charset=utf-8`` ``text/html;charset=utf-8``, ``text/plain;charset=utf-8``

View File

@ -1,6 +1,6 @@
--- ---
features: features:
- | - |
Adds a new cli option to tempest run, --combine, which is used to indicate Adds a new cli option to tempest run, ``--combine``, which is used
you want the subunit stream output combined with the previous run's in to indicate you want the subunit stream output combined with the
the testr repository previous run's in the testr repository

View File

@ -1,5 +1,5 @@
--- ---
upgrade: upgrade:
- | - |
The deprecated config option 'allow_port_security_disabled' from compute_feature_enabled The deprecated config option ``allow_port_security_disabled`` from
group has been removed. ``compute_feature_enabled`` group has been removed.

View File

@ -8,4 +8,4 @@ upgrade:
- ``compute.ssh_user`` (available as ``validation.image_ssh_user``) - ``compute.ssh_user`` (available as ``validation.image_ssh_user``)
- ``scenario.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.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``)

View File

@ -1,7 +1,7 @@
--- ---
features: features:
- | - |
Adds a new cli option to tempest run, --load-list <list-file> Adds a new cli option to tempest run, ``--load-list <list-file>``
to specify target tests to run from a list-file. The list-file 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. command.

View File

@ -1,4 +1,5 @@
--- ---
features: 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.

View File

@ -2,8 +2,8 @@
other: other:
- | - |
The CLIClient class, when it calls a command line client, uses The CLIClient class, when it calls a command line client, uses
--os-project-name instead of --os-tenant-name for the project, and ``--os-project-name`` instead of ``--os-tenant-name`` for the
passes --os-identity-api-version (default empty). project, and passes ``--os-identity-api-version`` (default empty).
All CLI clients still available in supported releases of OpenStack 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. switches.

View File

@ -1,8 +1,8 @@
--- ---
features: features:
- | - |
Adds a new CLI arg in tempest run, --black-regex, which is a regex to Adds a new CLI arg in tempest run, ``--black-regex``, which is a
exclude the tests that match it. regex to exclude the tests that match it.
fixes: fixes:
- | - |
Fixes tempest run CLI args mutually exclusive behavior which should not Fixes tempest run CLI args mutually exclusive behavior which should not

View File

@ -1,5 +1,5 @@
--- ---
features: features:
- | - |
Added tempest workspace remove --name <workspace_name> --rmdir Added tempest workspace remove ``--name <workspace_name> --rmdir``
feature to delete the workspace directory as well as entry. feature to delete the workspace directory as well as entry.