Commit 0fb66bb1 authored by Iustin Pop's avatar Iustin Pop

Fix inconsistent punctuation in rapi docs and opcodes

While reviewing the RAPI docs (for commit 003306f9), I realised that
the punctuation used in RAPI is inconsistent, especially with regards
to definition lists.

This patch changes all such lists to not have punctuation, except for
one case (the ecode descriptions, which have multiple
paragraphs). Furthermore, it fixes the few opcodes which had docs
ending with punctuation to not do so anymore.
Signed-off-by: default avatarIustin Pop <iustin@google.com>
Reviewed-by: default avatarMichael Hanselmann <hansmi@google.com>
parent 003306f9
......@@ -220,8 +220,8 @@ The instance policy specification is a dict with the following fields:
The numbers of nics used
:pyeval:`constants.ISPEC_SPINDLE_USE`
The numbers of virtual disk spindles used by this instance. They are
not real, but useful for account the spindle usage on the residing
node.
not real in the sense of actual HDD spindles, but useful for
accounting the spindle usage on the residing node
:pyeval:`constants.IPOLICY_DTS`
A `list` of disk templates allowed for instances using this policy
:pyeval:`constants.IPOLICY_VCPU_RATIO`
......@@ -388,12 +388,12 @@ features:
rlib2._NODE_EVAC_RES1])
:pyeval:`rlib2._INST_CREATE_REQV1`
Instance creation request data version 1 supported.
Instance creation request data version 1 supported
:pyeval:`rlib2._INST_REINSTALL_REQV1`
Instance reinstall supports body parameters.
Instance reinstall supports body parameters
:pyeval:`rlib2._NODE_MIGRATE_REQV1`
Whether migrating a node (``/2/nodes/[node_name]/migrate``) supports
request body parameters.
request body parameters
:pyeval:`rlib2._NODE_EVAC_RES1`
Whether evacuating a node (``/2/nodes/[node_name]/evacuate``) returns
a new-style result (see resource description)
......@@ -449,7 +449,7 @@ If the optional bool *bulk* argument is provided and set to a true value
(i.e ``?bulk=1``), the output contains detailed information about node
groups as a list.
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.G_FIELDS))`
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.G_FIELDS))`.
Example::
......@@ -508,7 +508,7 @@ It supports the following commands: ``GET``, ``DELETE``.
Returns information about a node group, similar to the bulk output from
the node group list.
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.G_FIELDS))`
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.G_FIELDS))`.
``DELETE``
~~~~~~~~~~
......@@ -657,7 +657,7 @@ If the optional bool *bulk* argument is provided and set to a true value
(i.e ``?bulk=1``), the output contains detailed information about
instances as a list.
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.I_FIELDS))`
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.I_FIELDS))`.
Example::
......@@ -732,7 +732,7 @@ It supports the following commands: ``GET``, ``DELETE``.
Returns information about an instance, similar to the bulk output from
the instance list.
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.I_FIELDS))`
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.I_FIELDS))`.
``DELETE``
~~~~~~~~~~
......@@ -1120,25 +1120,25 @@ console. Contained keys:
])
``instance``
Instance name.
Instance name
``kind``
Console type, one of :pyeval:`constants.CONS_SSH`,
:pyeval:`constants.CONS_VNC`, :pyeval:`constants.CONS_SPICE`
or :pyeval:`constants.CONS_MESSAGE`.
or :pyeval:`constants.CONS_MESSAGE`
``message``
Message to display (:pyeval:`constants.CONS_MESSAGE` type only).
Message to display (:pyeval:`constants.CONS_MESSAGE` type only)
``host``
Host to connect to (:pyeval:`constants.CONS_SSH`,
:pyeval:`constants.CONS_VNC` or :pyeval:`constants.CONS_SPICE` only).
:pyeval:`constants.CONS_VNC` or :pyeval:`constants.CONS_SPICE` only)
``port``
TCP port to connect to (:pyeval:`constants.CONS_VNC` or
:pyeval:`constants.CONS_SPICE` only).
:pyeval:`constants.CONS_SPICE` only)
``user``
Username to use (:pyeval:`constants.CONS_SSH` only).
Username to use (:pyeval:`constants.CONS_SSH` only)
``command``
Command to execute on machine (:pyeval:`constants.CONS_SSH` only)
``display``
VNC display number (:pyeval:`constants.CONS_VNC` only).
VNC display number (:pyeval:`constants.CONS_VNC` only)
``/2/instances/[instance_name]/tags``
......@@ -1201,7 +1201,7 @@ as a list.
Returned fields for bulk requests (unlike other bulk requests, these
fields are not the same as for per-job requests):
:pyeval:`utils.CommaJoin(sorted(rlib2.J_FIELDS_BULK))`
:pyeval:`utils.CommaJoin(sorted(rlib2.J_FIELDS_BULK))`.
``/2/jobs/[job_id]``
++++++++++++++++++++
......@@ -1309,14 +1309,14 @@ Waits for changes on a job. Takes the following body parameters in a
dict:
``fields``
The job fields on which to watch for changes.
The job fields on which to watch for changes
``previous_job_info``
Previously received field values or None if not yet available.
Previously received field values or None if not yet available
``previous_log_serial``
Highest log serial number received so far or None if not yet
available.
available
Returns None if no changes have been detected and a dict with two keys,
``job_info`` and ``log_entries`` otherwise.
......@@ -1351,7 +1351,7 @@ If the optional bool *bulk* argument is provided and set to a true value
(i.e ``?bulk=1``), the output contains detailed information about nodes
as a list.
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.N_FIELDS))`
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.N_FIELDS))`.
Example::
......@@ -1378,7 +1378,7 @@ Returns information about a node.
It supports the following commands: ``GET``.
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.N_FIELDS))`
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.N_FIELDS))`.
``/2/nodes/[node_name]/powercycle``
+++++++++++++++++++++++++++++++++++
......
......@@ -869,13 +869,13 @@ class OpClusterSetParams(OpCode):
("reserved_lvs", None, ht.TMaybeListOf(ht.TNonEmptyString),
"List of reserved LVs"),
("hidden_os", None, _TestClusterOsList,
"Modify list of hidden operating systems. Each modification must have"
" two items, the operation and the OS name. The operation can be"
" ``%s`` or ``%s``." % (constants.DDM_ADD, constants.DDM_REMOVE)),
"Modify list of hidden operating systems: each modification must have"
" two items, the operation and the OS name; the operation can be"
" ``%s`` or ``%s``" % (constants.DDM_ADD, constants.DDM_REMOVE)),
("blacklisted_os", None, _TestClusterOsList,
"Modify list of blacklisted operating systems. Each modification must have"
" two items, the operation and the OS name. The operation can be"
" ``%s`` or ``%s``." % (constants.DDM_ADD, constants.DDM_REMOVE)),
"Modify list of blacklisted operating systems: each modification must"
" have two items, the operation and the OS name; the operation can be"
" ``%s`` or ``%s``" % (constants.DDM_ADD, constants.DDM_REMOVE)),
("use_external_mip_script", None, ht.TMaybeBool,
"Whether to use an external master IP address setup script"),
]
......@@ -1500,17 +1500,17 @@ class OpInstanceSetParams(OpCode):
_PForceVariant,
_PIgnoreIpolicy,
("nics", ht.EmptyList, TestNicModifications,
"List of NIC changes. Each item is of the form ``(op, index, settings)``."
" ``op`` is one of ``%s``, ``%s`` or ``%s``. ``index`` can be either -1 to"
" refer to the last position, or a zero-based index number. A deprecated"
" version of this parameter used the form ``(op, settings)``, where "
" ``op`` can be ``%s`` to add a new NIC with the specified settings,"
" ``%s`` to remove the last NIC or a number to modify the settings"
" of the NIC with that index." %
"List of NIC changes: each item is of the form ``(op, index, settings)``,"
" ``op`` is one of ``%s``, ``%s`` or ``%s``, ``index`` can be either -1"
" to refer to the last position, or a zero-based index number; a"
" deprecated version of this parameter used the form ``(op, settings)``,"
" where ``op`` can be ``%s`` to add a new NIC with the specified"
" settings, ``%s`` to remove the last NIC or a number to modify the"
" settings of the NIC with that index" %
(constants.DDM_ADD, constants.DDM_MODIFY, constants.DDM_REMOVE,
constants.DDM_ADD, constants.DDM_REMOVE)),
("disks", ht.EmptyList, TestDiskModifications,
"List of disk changes. See ``nics``."),
"List of disk changes; see ``nics``"),
("beparams", ht.EmptyDict, ht.TDict, "Per-instance backend parameters"),
("runtime_mem", None, ht.TMaybeStrictPositiveInt, "New runtime memory"),
("hvparams", ht.EmptyDict, ht.TDict,
......@@ -1520,7 +1520,7 @@ class OpInstanceSetParams(OpCode):
("remote_node", None, ht.TMaybeString,
"Secondary node (used when changing disk template)"),
("os_name", None, ht.TMaybeString,
"Change instance's OS name. Does not reinstall the instance."),
"Change the instance's OS without reinstalling the instance"),
("osparams", None, ht.TMaybeDict, "Per-instance OS parameters"),
("wait_for_sync", True, ht.TBool,
"Whether to wait for the disk to synchronize, when changing template"),
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment