10 Commits

Author SHA1 Message Date
Dean Troyer
1686dc54f0 Help/docs cleanups: marker, limit, ip-address metavars
Cleanup help strings and docs for clarity and to keep things consistent:
* --limit metavar should be <num-resource> to indicate what is being counted
* --marker metavar should be <resource> or <resource-id> to indicate the
  type of value being specified
* <*-ip-address> metavars should be just <ip-address> as there is no difference
  in format between fixed and floating IPs
* Move all occurances of '(name or ID)' to end of help text

Change-Id: I2c31746ed6ded3845244e03e57d809f8bc0e6b9d
2017-04-04 03:56:19 +00:00
Kevin_Zheng
9663424c74 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
2016-12-20 09:03:29 +08:00
zheng yin
f2f12d91f7 remove square backet to required parameter
Required parameter don't need to square backet, therefore, I remove them.

Change-Id: I36517fb782da53b3b973f70f292f25a4f6784077
2016-09-25 15:49:40 +08:00
TerryHowe
514a168656 Add recursive object delete for containers
Change-Id: Ib291e79864c218464e842a08efd3742193ba5ff0
2016-02-05 11:18:46 -07:00
Xi Yang
32e0ed6980 Change 'Object Store' to 'Object Storage'
Because the official documents uses 'Object Storage',
so change it in this project.

Change-Id: I87c0996b48c452b3ff619b8214676ae377e6d0af
2015-11-26 16:35:54 +08:00
Dean Troyer
578a57dcc3 Set object store arg order in docs
argparse displays positional args last in the help output,
our docs should match.

Change-Id: I01e8d62cb8c1b537ea0441b8bdf8880a4c856b32
2015-10-06 08:46:31 -05:00
Steve Martinelli
abaf711e24 add support for set/unset of container properties
include docs and commands to set and unset container properties

Partial-Bug: #1501945

Change-Id: I8d7e8cf356a2321a37ed940c4e10cae411b94dfd
2015-10-06 00:18:59 -04:00
Steve Martinelli
27b73ac55d Fix doc building errors
Addresses some of the issues that appeared when running tox -edocs

Change-Id: I31133744ee0ddefa72c6590cb381de317e65633e
2015-01-19 13:12:18 -05:00
Steve Martinelli
019c155e9b Fine tune some of the helps commands
try and add some consistency with the show and delete commands.

replace 'show x' with 'display x'
change 'delete a y' with just 'delete y'

Change-Id: I47dfa8ee23ac5c41b355796415eb515155832f65
2015-01-13 00:58:57 -05:00
Dean Troyer
d5caa6a26b Command object docs: container, object
Change-Id: Ie3df543a28cbee0cc809310a05f431c97b2c7e70
2014-12-30 16:09:54 -05:00