From d70df6a4a2bdd99d22051cb999e7c4b36e4e5868 Mon Sep 17 00:00:00 2001 From: TerryHowe Date: Tue, 21 Jul 2015 14:07:18 -0600 Subject: [PATCH] Fix yet more documentation warnings Change-Id: I87683039601ae90531f27ebebbc4d0b1d252e846 --- doc/source/command-objects/endpoint.rst | 2 +- doc/source/command-objects/image.rst | 6 +++--- doc/source/command-objects/keypair.rst | 8 ++++---- doc/source/command-objects/project.rst | 3 ++- doc/source/command-objects/user.rst | 4 ++-- doc/source/releases.rst | 4 ++-- 6 files changed, 14 insertions(+), 13 deletions(-) diff --git a/doc/source/command-objects/endpoint.rst b/doc/source/command-objects/endpoint.rst index 7846a1b1..074f20a0 100644 --- a/doc/source/command-objects/endpoint.rst +++ b/doc/source/command-objects/endpoint.rst @@ -48,7 +48,7 @@ Create new endpoint .. code:: bash os endpoint create - [--region + [--region ] [--enable | --disable] diff --git a/doc/source/command-objects/image.rst b/doc/source/command-objects/image.rst index c4b24233..25741424 100644 --- a/doc/source/command-objects/image.rst +++ b/doc/source/command-objects/image.rst @@ -246,7 +246,7 @@ Set image properties Disk format of image. Acceptable formats: ['ami', 'ari', 'aki', 'vhd', 'vmdk', 'raw', 'qcow2', - 'vdi', 'iso'] + 'vdi', 'iso'] .. option:: --size @@ -330,7 +330,7 @@ image add project Associate project with image -.. progran:: image add project +.. program:: image add project .. code:: bash os image add project @@ -357,7 +357,7 @@ image remove project Disassociate project with image -.. progran:: image remove project +.. program:: image remove project .. code:: bash os image remove remove diff --git a/doc/source/command-objects/keypair.rst b/doc/source/command-objects/keypair.rst index 04c5721f..e49acace 100644 --- a/doc/source/command-objects/keypair.rst +++ b/doc/source/command-objects/keypair.rst @@ -12,7 +12,7 @@ keypair create Create new public key -.. program keypair create +.. program:: keypair create .. code:: bash os keypair create @@ -32,7 +32,7 @@ keypair delete Delete public key -.. program keypair delete +.. program:: keypair delete .. code:: bash os keypair delete @@ -47,7 +47,7 @@ keypair list List public key fingerprints -.. program keypair list +.. program:: keypair list .. code:: bash os keypair list @@ -57,7 +57,7 @@ keypair show Display public key details -.. program keypair show +.. program:: keypair show .. code:: bash os keypair show diff --git a/doc/source/command-objects/project.rst b/doc/source/command-objects/project.rst index a8a6e812..a342115d 100644 --- a/doc/source/command-objects/project.rst +++ b/doc/source/command-objects/project.rst @@ -70,11 +70,12 @@ Delete project(s) .. code:: bash os project delete + [--domain ] [ ...] .. option:: --domain - Domain owning :ref:`\ <_project_delete-project>` (name or ID) + Domain owning :ref:`\ ` (name or ID) .. versionadded:: 3 diff --git a/doc/source/command-objects/user.rst b/doc/source/command-objects/user.rst index 2e297bb3..fbc0b6de 100644 --- a/doc/source/command-objects/user.rst +++ b/doc/source/command-objects/user.rst @@ -83,16 +83,16 @@ Delete user(s) .. code:: bash os user delete + [--domain ] [ ...] .. option:: --domain - Domain owning :ref:`\ <_user_delete-user>` (name or ID) + Domain owning :ref:`\ ` (name or ID) .. versionadded:: 3 .. _user_delete-user: - .. describe:: User to delete (name or ID) diff --git a/doc/source/releases.rst b/doc/source/releases.rst index b8402cc9..4af9761b 100644 --- a/doc/source/releases.rst +++ b/doc/source/releases.rst @@ -100,7 +100,7 @@ Release Notes Bug `1446751 `_ * Document the backward-compatibility-breaking changes in - :doc:`backwards-incompatibile`. + :doc:`backwards-incompatible`. Bug `1406470 `_ * Add `--parent`` option to `projct create` command. @@ -203,7 +203,7 @@ Release Notes * Set a default domain ID when both ``OS_USER_DOMAIN_ID`` and ``OS_USER_DOMAIN_NAME`` are not set. This is also done for - ``OS_PROJECT_DOMAIN_ID`` and ``OS_PROJECT_DOMAIN_NAME`. + ``OS_PROJECT_DOMAIN_ID`` and ``OS_PROJECT_DOMAIN_NAME``. (*Identity API v3 only*). Bug `1385338 `_: Improve domain related defaults when using v3 identity