From 9663424c7444e0f5ae54dda499a96f179d8512fd Mon Sep 17 00:00:00 2001 From: Kevin_Zheng Date: Tue, 20 Dec 2016 09:03:29 +0800 Subject: [PATCH] change os in command example to openstack In the current doc, the command examples are like "os server create" but the acutal command should be started with "openstack" instead of "os", it is misleading to first time users. Change-Id: Ic7686257725e1aa8e4e0d65a712eff1c079927a8 --- doc/source/command-objects/access-token.rst | 2 +- doc/source/command-objects/address-scope.rst | 10 +++++----- doc/source/command-objects/aggregate.rst | 16 ++++++++-------- doc/source/command-objects/availability-zone.rst | 2 +- doc/source/command-objects/backup.rst | 10 +++++----- doc/source/command-objects/catalog.rst | 4 ++-- doc/source/command-objects/command.rst | 2 +- doc/source/command-objects/complete.rst | 2 +- doc/source/command-objects/compute-agent.rst | 8 ++++---- doc/source/command-objects/compute-service.rst | 6 +++--- doc/source/command-objects/configuration.rst | 2 +- .../consistency-group-snapshot.rst | 8 ++++---- doc/source/command-objects/consistency-group.rst | 10 +++++----- doc/source/command-objects/console-log.rst | 2 +- doc/source/command-objects/console-url.rst | 2 +- doc/source/command-objects/consumer.rst | 10 +++++----- doc/source/command-objects/container.rst | 14 +++++++------- doc/source/command-objects/credential.rst | 10 +++++----- doc/source/command-objects/domain.rst | 10 +++++----- doc/source/command-objects/ec2-credentials.rst | 8 ++++---- doc/source/command-objects/endpoint.rst | 12 ++++++------ doc/source/command-objects/extension.rst | 2 +- 22 files changed, 76 insertions(+), 76 deletions(-) diff --git a/doc/source/command-objects/access-token.rst b/doc/source/command-objects/access-token.rst index fd22e761f8..b1400412ff 100644 --- a/doc/source/command-objects/access-token.rst +++ b/doc/source/command-objects/access-token.rst @@ -14,7 +14,7 @@ Create an access token .. program:: access token create .. code:: bash - os access token create + openstack access token create --consumer-key --consumer-secret --request-key diff --git a/doc/source/command-objects/address-scope.rst b/doc/source/command-objects/address-scope.rst index f7572d97da..9155d09ed1 100644 --- a/doc/source/command-objects/address-scope.rst +++ b/doc/source/command-objects/address-scope.rst @@ -15,7 +15,7 @@ Create new address scope .. program:: address scope create .. code:: bash - os address scope create + openstack address scope create [--project [--project-domain ]] [--ip-version ] [--share | --no-share] @@ -55,7 +55,7 @@ Delete address scope(s) .. program:: address scope delete .. code:: bash - os address scope delete + openstack address scope delete [ ...] .. _address_scope_delete-address-scope: @@ -71,7 +71,7 @@ List address scopes .. program:: address scope list .. code:: bash - os address scope list + openstack address scope list [--name ] [--ip-version ] [--project [--project-domain ]] @@ -110,7 +110,7 @@ Set address scope properties .. program:: address scope set .. code:: bash - os address scope set + openstack address scope set [--name ] [--share | --no-share] @@ -140,7 +140,7 @@ Display address scope details .. program:: address scope show .. code:: bash - os address scope show + openstack address scope show .. _address_scope_show-address-scope: diff --git a/doc/source/command-objects/aggregate.rst b/doc/source/command-objects/aggregate.rst index 642942d457..0d2926db7d 100644 --- a/doc/source/command-objects/aggregate.rst +++ b/doc/source/command-objects/aggregate.rst @@ -15,7 +15,7 @@ Add host to aggregate .. program:: aggregate add host .. code:: bash - os aggregate add host + openstack aggregate add host @@ -36,7 +36,7 @@ Create a new aggregate .. program:: aggregate create .. code:: bash - os aggregate create + openstack aggregate create [--zone ] [--property [...] ] @@ -61,7 +61,7 @@ Delete existing aggregate(s) .. program:: aggregate delete .. code:: bash - os aggregate delete + openstack aggregate delete [ ...] .. describe:: @@ -76,7 +76,7 @@ List all aggregates .. program:: aggregate list .. code:: bash - os aggregate list + openstack aggregate list [--long] .. option:: --long @@ -91,7 +91,7 @@ Remove host from aggregate .. program:: aggregate remove host .. code:: bash - os aggregate remove host + openstack aggregate remove host @@ -112,7 +112,7 @@ Set aggregate properties .. program:: aggregate set .. code:: bash - os aggregate set + openstack aggregate set [--name ] [--zone ] [--property [...] ] @@ -151,7 +151,7 @@ Display aggregate details .. program:: aggregate show .. code:: bash - os aggregate show + openstack aggregate show .. describe:: @@ -166,7 +166,7 @@ Unset aggregate properties .. program:: aggregate unset .. code-block:: bash - os aggregate unset + openstack aggregate unset [--property [...] ] diff --git a/doc/source/command-objects/availability-zone.rst b/doc/source/command-objects/availability-zone.rst index 149e10811d..d4c117a0f8 100644 --- a/doc/source/command-objects/availability-zone.rst +++ b/doc/source/command-objects/availability-zone.rst @@ -15,7 +15,7 @@ List availability zones and their status .. program availability zone list .. code:: bash - os availability zone list + openstack availability zone list [--compute] [--network] [--volume] diff --git a/doc/source/command-objects/backup.rst b/doc/source/command-objects/backup.rst index ac88708636..f892327695 100644 --- a/doc/source/command-objects/backup.rst +++ b/doc/source/command-objects/backup.rst @@ -13,7 +13,7 @@ Create new backup .. program:: backup create .. code:: bash - os backup create + openstack backup create [--container ] [--name ] [--description ] @@ -66,7 +66,7 @@ Delete backup(s) .. program:: backup delete .. code:: bash - os backup delete + openstack backup delete [--force] [ ...] @@ -90,7 +90,7 @@ List backups .. program:: backup list .. code:: bash - os backup list + openstack backup list .. _backup_list-backup: .. option:: --long @@ -106,7 +106,7 @@ Restore backup .. program:: backup restore .. code:: bash - os backup restore + openstack backup restore @@ -128,7 +128,7 @@ Display backup details .. program:: backup show .. code:: bash - os backup show + openstack backup show .. _backup_show-backup: diff --git a/doc/source/command-objects/catalog.rst b/doc/source/command-objects/catalog.rst index 4319fb111f..dccf780121 100644 --- a/doc/source/command-objects/catalog.rst +++ b/doc/source/command-objects/catalog.rst @@ -12,7 +12,7 @@ List services in the service catalog .. program:: catalog list .. code:: bash - os catalog list + openstack catalog list catalog show ------------ @@ -22,7 +22,7 @@ Display service catalog details .. program:: catalog show .. code:: bash - os catalog show + openstack catalog show .. describe:: diff --git a/doc/source/command-objects/command.rst b/doc/source/command-objects/command.rst index ac4f851438..34c07da625 100644 --- a/doc/source/command-objects/command.rst +++ b/doc/source/command-objects/command.rst @@ -14,4 +14,4 @@ List recognized commands by group .. program:: command list .. code:: bash - os command list + openstack command list diff --git a/doc/source/command-objects/complete.rst b/doc/source/command-objects/complete.rst index 8f84eec10a..20e5c41da4 100644 --- a/doc/source/command-objects/complete.rst +++ b/doc/source/command-objects/complete.rst @@ -22,4 +22,4 @@ print bash completion command .. program:: complete .. code:: bash - os complete + openstack complete diff --git a/doc/source/command-objects/compute-agent.rst b/doc/source/command-objects/compute-agent.rst index 239a24e830..e8317b4825 100644 --- a/doc/source/command-objects/compute-agent.rst +++ b/doc/source/command-objects/compute-agent.rst @@ -12,7 +12,7 @@ Create compute agent .. program:: compute agent create .. code:: bash - os compute agent create + openstack compute agent create @@ -49,7 +49,7 @@ Delete compute agent(s) .. program:: compute agent delete .. code:: bash - os compute agent delete [ ...] + openstack compute agent delete [ ...] .. _compute_agent-delete: .. describe:: @@ -64,7 +64,7 @@ List compute agents .. program:: compute agent list .. code:: bash - os compute agent list [--hypervisor ] + openstack compute agent list [--hypervisor ] .. option:: --hypervisor @@ -78,7 +78,7 @@ Set compute agent properties .. program:: agent set .. code:: bash - os compute agent set + openstack compute agent set [--agent-version ] [--url ] diff --git a/doc/source/command-objects/compute-service.rst b/doc/source/command-objects/compute-service.rst index 57dd2ba556..66347214e4 100644 --- a/doc/source/command-objects/compute-service.rst +++ b/doc/source/command-objects/compute-service.rst @@ -12,7 +12,7 @@ Delete compute service(s) .. program:: compute service delete .. code:: bash - os compute service delete + openstack compute service delete [ ...] .. _compute-service-delete: @@ -28,7 +28,7 @@ List compute services .. program:: compute service list .. code:: bash - os compute service list + openstack compute service list [--host ] [--service ] [--long] @@ -55,7 +55,7 @@ Set compute service properties .. program:: compute service set .. code:: bash - os compute service set + openstack compute service set [--enable | --disable] [--disable-reason ] [--up | --down] diff --git a/doc/source/command-objects/configuration.rst b/doc/source/command-objects/configuration.rst index 7bf054c072..0e00bbe9a0 100644 --- a/doc/source/command-objects/configuration.rst +++ b/doc/source/command-objects/configuration.rst @@ -15,7 +15,7 @@ show different configurations. .. program:: configuration show .. code:: bash - os configuration show + openstack configuration show [--mask | --unmask] .. option:: --mask diff --git a/doc/source/command-objects/consistency-group-snapshot.rst b/doc/source/command-objects/consistency-group-snapshot.rst index b7b1423e8a..3d455038ec 100644 --- a/doc/source/command-objects/consistency-group-snapshot.rst +++ b/doc/source/command-objects/consistency-group-snapshot.rst @@ -12,7 +12,7 @@ Create new consistency group snapshot. .. program:: consistency group snapshot create .. code:: bash - os consistency group snapshot create + openstack consistency group snapshot create [--consistency-group ] [--description ] [] @@ -39,7 +39,7 @@ Delete consistency group snapshot(s) .. program:: consistency group snapshot delete .. code:: bash - os consistency group snapshot delete + openstack consistency group snapshot delete [ ...] .. _consistency_group_snapshot_delete-consistency-group-snapshot: @@ -55,7 +55,7 @@ List consistency group snapshots. .. program:: consistency group snapshot list .. code:: bash - os consistency group snapshot list + openstack consistency group snapshot list [--all-projects] [--long] [--status ] @@ -87,7 +87,7 @@ Display consistency group snapshot details. .. program:: consistency group snapshot show .. code:: bash - os consistency group snapshot show + openstack consistency group snapshot show .. _consistency_group_snapshot_show-consistency-group-snapshot: diff --git a/doc/source/command-objects/consistency-group.rst b/doc/source/command-objects/consistency-group.rst index 910fbba9a1..658d942502 100644 --- a/doc/source/command-objects/consistency-group.rst +++ b/doc/source/command-objects/consistency-group.rst @@ -12,7 +12,7 @@ Create new consistency group. .. program:: consistency group create .. code:: bash - os consistency group create + openstack consistency group create --volume-type | --consistency-group-source | --consistency-group-snapshot [--description ] [--availability-zone ] @@ -52,7 +52,7 @@ Delete consistency group(s). .. program:: consistency group delete .. code:: bash - os consistency group delete + openstack consistency group delete [--force] [ ...] @@ -73,7 +73,7 @@ List consistency groups. .. program:: consistency group list .. code:: bash - os consistency group list + openstack consistency group list [--all-projects] [--long] @@ -94,7 +94,7 @@ Set consistency group properties. .. program:: consistency group set .. code:: bash - os consistency group set + openstack consistency group set [--name ] [--description ] @@ -120,7 +120,7 @@ Display consistency group details. .. program:: consistency group show .. code:: bash - os consistency group show + openstack consistency group show .. _consistency_group_show-consistency-group: diff --git a/doc/source/command-objects/console-log.rst b/doc/source/command-objects/console-log.rst index 9eafb61ae2..bcb23e7009 100644 --- a/doc/source/command-objects/console-log.rst +++ b/doc/source/command-objects/console-log.rst @@ -14,7 +14,7 @@ Show server's console output .. program:: console log show .. code:: bash - os console log show + openstack console log show [--lines ] diff --git a/doc/source/command-objects/console-url.rst b/doc/source/command-objects/console-url.rst index 08c8333248..8a5807b6a3 100644 --- a/doc/source/command-objects/console-url.rst +++ b/doc/source/command-objects/console-url.rst @@ -14,7 +14,7 @@ Show server's remote console URL .. program:: console url show .. code:: bash - os console url show + openstack console url show [--novnc | --xvpvnc | --spice] [--rdp | --serial | --mks] diff --git a/doc/source/command-objects/consumer.rst b/doc/source/command-objects/consumer.rst index 335eaea32f..d4ce5dc5b2 100644 --- a/doc/source/command-objects/consumer.rst +++ b/doc/source/command-objects/consumer.rst @@ -14,7 +14,7 @@ Create new consumer .. program:: consumer create .. code:: bash - os consumer create + openstack consumer create [--description ] .. option:: --description @@ -29,7 +29,7 @@ Delete consumer(s) .. program:: consumer delete .. code:: bash - os consumer delete + openstack consumer delete [ ...] .. describe:: @@ -44,7 +44,7 @@ List consumers .. program:: consumer list .. code:: bash - os consumer list + openstack consumer list consumer set ------------ @@ -54,7 +54,7 @@ Set consumer properties .. program:: consumer set .. code:: bash - os consumer set + openstack consumer set [--description ] @@ -74,7 +74,7 @@ Display consumer details .. program:: consumer show .. code:: bash - os consumer show + openstack consumer show .. _consumer_show-consumer: diff --git a/doc/source/command-objects/container.rst b/doc/source/command-objects/container.rst index adcf0961da..c431047293 100644 --- a/doc/source/command-objects/container.rst +++ b/doc/source/command-objects/container.rst @@ -12,7 +12,7 @@ Create new container .. program:: container create .. code:: bash - os container create + openstack container create [ ...] .. describe:: @@ -27,7 +27,7 @@ Delete container .. program:: container delete .. code:: bash - os container delete + openstack container delete [-r] | [--recursive] [ ...] @@ -47,7 +47,7 @@ List containers .. program:: container list .. code:: bash - os container list + openstack container list [--prefix ] [--marker ] [--end-marker ] @@ -87,7 +87,7 @@ Save container contents locally .. program:: container save .. code:: bash - os container save + openstack container save .. describe:: @@ -102,7 +102,7 @@ Set container properties .. program:: container set .. code:: bash - os container set + openstack container set [--property [...] ] @@ -122,7 +122,7 @@ Display container details .. program:: container show .. code:: bash - os container show + openstack container show .. describe:: @@ -137,7 +137,7 @@ Unset container properties .. program:: container unset .. code:: bash - os container unset + openstack container unset [--property ] diff --git a/doc/source/command-objects/credential.rst b/doc/source/command-objects/credential.rst index 538362a864..0b835c73f1 100644 --- a/doc/source/command-objects/credential.rst +++ b/doc/source/command-objects/credential.rst @@ -12,7 +12,7 @@ Create new credential .. program:: credential create .. code:: bash - os credential create + openstack credential create [--type ] [--project ] @@ -42,7 +42,7 @@ Delete credential(s) .. program:: credential delete .. code:: bash - os credential delete + openstack credential delete [ ...] .. _credential_delete: @@ -58,7 +58,7 @@ List credentials .. program:: credential list .. code:: bash - os credential list + openstack credential list credential set -------------- @@ -68,7 +68,7 @@ Set credential properties .. program:: credential set .. code:: bash - os credential set + openstack credential set [--user ] [--type ] [--data ] @@ -104,7 +104,7 @@ Display credential details .. program:: credential show .. code:: bash - os credential show + openstack credential show .. _credential_show: diff --git a/doc/source/command-objects/domain.rst b/doc/source/command-objects/domain.rst index 573a78cb27..70a3e73309 100644 --- a/doc/source/command-objects/domain.rst +++ b/doc/source/command-objects/domain.rst @@ -12,7 +12,7 @@ Create new domain .. program:: domain create .. code:: bash - os domain create + openstack domain create [--description ] [--enable | --disable] [--or-show] @@ -48,7 +48,7 @@ Delete domain(s) .. program:: domain delete .. code:: bash - os domain delete + openstack domain delete [ ...] .. describe:: @@ -63,7 +63,7 @@ List domains .. program:: domain list .. code:: bash - os domain list + openstack domain list domain set ---------- @@ -73,7 +73,7 @@ Set domain properties .. program:: domain set .. code:: bash - os domain set + openstack domain set [--name ] [--description ] [--enable | --disable] @@ -107,7 +107,7 @@ Display domain details .. program:: domain show .. code:: bash - os domain show + openstack domain show .. describe:: diff --git a/doc/source/command-objects/ec2-credentials.rst b/doc/source/command-objects/ec2-credentials.rst index caf7fd6901..9174b0413e 100644 --- a/doc/source/command-objects/ec2-credentials.rst +++ b/doc/source/command-objects/ec2-credentials.rst @@ -12,7 +12,7 @@ Create EC2 credentials .. program:: ec2 credentials create .. code-block:: bash - os ec2 credentials create + openstack ec2 credentials create [--project ] [--user ] [--user-domain ] @@ -52,7 +52,7 @@ Delete EC2 credentials .. program:: ec2 credentials delete .. code-block:: bash - os ec2 credentials delete + openstack ec2 credentials delete [--user ] [--user-domain ] [ ...] @@ -85,7 +85,7 @@ List EC2 credentials .. program:: ec2 credentials list .. code-block:: bash - os ec2 credentials list + openstack ec2 credentials list [--user ] [--user-domain ] @@ -112,7 +112,7 @@ Display EC2 credentials details .. program:: ec2 credentials show .. code-block:: bash - os ec2 credentials show + openstack ec2 credentials show [--user ] [--user-domain ] diff --git a/doc/source/command-objects/endpoint.rst b/doc/source/command-objects/endpoint.rst index c058c8444e..d6eb362af5 100644 --- a/doc/source/command-objects/endpoint.rst +++ b/doc/source/command-objects/endpoint.rst @@ -14,7 +14,7 @@ Create new endpoint .. program:: endpoint create .. code:: bash - os endpoint create + openstack endpoint create --publicurl [--adminurl ] [--internalurl ] @@ -47,7 +47,7 @@ Create new endpoint .. program:: endpoint create .. code:: bash - os endpoint create + openstack endpoint create [--region ] [--enable | --disable] @@ -86,7 +86,7 @@ Delete endpoint(s) .. program:: endpoint delete .. code:: bash - os endpoint delete + openstack endpoint delete [ ...] .. _endpoint_delete-endpoint: @@ -102,7 +102,7 @@ List endpoints .. program:: endpoint list .. code:: bash - os endpoint list + openstack endpoint list [--service ] [--region ] @@ -142,7 +142,7 @@ Set endpoint properties .. program:: endpoint set .. code:: bash - os endpoint set + openstack endpoint set [--region ] [--interface ] [--url ] @@ -187,7 +187,7 @@ Display endpoint details .. program:: endpoint show .. code:: bash - os endpoint show + openstack endpoint show .. _endpoint_show-endpoint: diff --git a/doc/source/command-objects/extension.rst b/doc/source/command-objects/extension.rst index dff30fa137..b7ba5c0a42 100644 --- a/doc/source/command-objects/extension.rst +++ b/doc/source/command-objects/extension.rst @@ -13,7 +13,7 @@ List API extensions .. program:: extension list .. code:: bash - os extension list + openstack extension list [--compute] [--identity] [--network]