From b5ce0f145f9342a01370ac34a7a11d40df703249 Mon Sep 17 00:00:00 2001 From: Dean Troyer Date: Wed, 31 Dec 2014 10:05:37 -0600 Subject: Command docs: region Fix up formatting fro region command docs and help Change-Id: Icf8c03da38b30fc69e7fe70f9c14aaa99881d320 --- doc/source/command-objects/region.rst | 68 ++++++++++++++++++++++------------- 1 file changed, 44 insertions(+), 24 deletions(-) (limited to 'doc/source/command-objects') diff --git a/doc/source/command-objects/region.rst b/doc/source/command-objects/region.rst index 788ed6fa..d1aedb31 100644 --- a/doc/source/command-objects/region.rst +++ b/doc/source/command-objects/region.rst @@ -9,24 +9,30 @@ region create Create new region +.. program:: region create .. code:: bash os region create [--parent-region ] - [--description ] - [--url ] + [--description ] + [--url ] -:option:`--parent-region` - Parent region +.. option:: --parent-region + + Parent region ID + +.. option:: --description -:option:`--description` New region description -:option:`--url` +.. option:: --url + New region URL -:option:`` +.. _region_create-region-id: +.. describe:: + New region ID region delete @@ -34,61 +40,75 @@ region delete Delete region +.. program:: region delete .. code:: bash os region delete - + + +.. _region_delete-region-id: +.. describe:: -:option:`` - Region to delete + Region ID to delete region list ----------- List regions +.. program:: region list .. code:: bash os region list [--parent-region ] -:option:`--parent-region` - Filter by a specific parent region +.. option:: --parent-region + + Filter by parent region ID region set ---------- Set region properties +.. program:: region set .. code:: bash os region set [--parent-region ] - [--description ] - [--url ] - + [--description ] + [--url ] + -:option:`--parent-region` - New parent region +.. option:: --parent-region + + New parent region ID + +.. option:: --description -:option:`--description` New region description -:option:`--url` +.. option:: --url + New region URL -:option:`` +.. _region_set-region-id: +.. describe:: + Region ID to modify region show ----------- -Show region +Display region details +.. program:: region show .. code:: bash os region show - + -:option:`` - Region ID to modify +.. _region_show-region-id: +.. describe:: + + Region ID to display -- cgit v1.2.1