summaryrefslogtreecommitdiff
path: root/doc/rtd/topics/capabilities.rst
diff options
context:
space:
mode:
authorScott Moser <smoser@ubuntu.com>2018-03-15 13:32:09 -0400
committerScott Moser <smoser@brickies.net>2018-03-15 13:32:09 -0400
commit837021fd3ded8262ff7131efe6cfd4c7ce489e2b (patch)
treef0af63a31f11bc88bda375efc711e1bc6c10565c /doc/rtd/topics/capabilities.rst
parentb389b196c834e4eaf9020952a92cd471ced599d2 (diff)
downloadvyos-cloud-init-837021fd3ded8262ff7131efe6cfd4c7ce489e2b.tar.gz
vyos-cloud-init-837021fd3ded8262ff7131efe6cfd4c7ce489e2b.zip
doc: fix all warnings issued by 'tox -e doc'
Building doc would issue some warnings. This fixes all the warnings, and changes the "code blocks" that were listed as 'bash' to instead be 'shell-session'.
Diffstat (limited to 'doc/rtd/topics/capabilities.rst')
-rw-r--r--doc/rtd/topics/capabilities.rst14
1 files changed, 8 insertions, 6 deletions
diff --git a/doc/rtd/topics/capabilities.rst b/doc/rtd/topics/capabilities.rst
index ae3a0c74..3e2c9e31 100644
--- a/doc/rtd/topics/capabilities.rst
+++ b/doc/rtd/topics/capabilities.rst
@@ -44,13 +44,14 @@ Currently defined feature names include:
CLI Interface
=============
- The command line documentation is accessible on any cloud-init
-installed system:
+The command line documentation is accessible on any cloud-init installed
+system:
-.. code-block:: bash
+.. code-block:: shell-session
% cloud-init --help
usage: cloud-init [-h] [--version] [--file FILES]
+
[--debug] [--force]
{init,modules,single,dhclient-hook,features,analyze,devel,collect-logs,clean,status}
...
@@ -88,7 +89,7 @@ Print out each feature supported. If cloud-init does not have the
features subcommand, it also does not support any features described in
this document.
-.. code-block:: bash
+.. code-block:: shell-session
% cloud-init features
NETWORK_CONFIG_V1
@@ -100,10 +101,11 @@ cloud-init status
-----------------
Report whether cloud-init is running, done, disabled or errored. Exits
non-zero if an error is detected in cloud-init.
+
* **--long**: Detailed status information.
* **--wait**: Block until cloud-init completes.
-.. code-block:: bash
+.. code-block:: shell-session
% cloud-init status --long
status: done
@@ -214,7 +216,7 @@ of once-per-instance:
* **--frequency**: Optionally override the declared module frequency
with one of (always|once-per-instance|once)
-.. code-block:: bash
+.. code-block:: shell-session
% cloud-init single --name set_hostname --frequency always