summaryrefslogtreecommitdiff
path: root/doc/source/command-options.rst
Commit message (Collapse)AuthorAgeFilesLines
* reorganize existing documentation according to the new standard layoutDoug Hellmann2017-06-231-312/+0
| | | | | | | | | | | | | Move existing content around based on the doc-migration specification. Replace :doc: markup with :ref: to have sphinx keep track of where the files move and generate valid hyperlinks. Add a few toctrees and index pages for the new directories. Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
* Help/docs cleanups: marker, limit, ip-address metavarsDean Troyer2017-04-041-6/+6
| | | | | | | | | | | | 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
* doc: Correct Sphinx warningsStephen Finucane2017-03-281-3/+4
| | | | | | | | | | | | | | | - Fix option-describe typos - Correct option and envvar markup, for commands that are using the reference form instead of the definition form or are marking up option arguments as options - Avoid duplicate commands - Fix some invalid docstrings - Fix some invalid indentation - Disable the murano plugin, which has invalid docs - Correct issues with- and track the network-topology spec - Include API modules in docs Change-Id: I3d5ed5e872540fe13f3e4bd5e9335829dc9a5226
* Update devref about "--no-property"Rui Chen2017-01-221-11/+15
| | | | | | | | | | | Update the example about "--no-property" and "--property" to make help message order more reasonable, that help make users aware of the processing order, and update the help details when both "--no-property" and "--property" appear in the same command. Change-Id: I998cdaf2f8c881dce219581ff328a639e8e358ee Implements: blueprint allow-overwrite-set-options
* Redefine set/unset command devrefRui Chen2016-10-101-10/+12
| | | | | | | | | | | | | | | | | | | | | Now we have some use cases about set/unset properties, try to redefine devref to find out a best and easiest solution to keep commands simple and clearly. Five use cases exist in property action, "append", "update", "remove", "clean", "override", the following rules can cover all these use cases: 1. append ==> "set --property new-key=value" 2. update ==> "set --property existed-key=new-value" 3. remove ==> "unset --property existed-key" 4. clean ==> "set --no-property" 5. clean ==> "unset --all-property" 6. override ==> "set --no-property --property new-key=value" Related blueprint support-no-property-in-aggregate and blueprint allow-overwrite-set-options. Change-Id: If86daf6989d8e0ad0dc6e590d7636be7d5203a18
* Fix six typosAtsushi SAKAI2016-08-251-3/+3
| | | | | | | | | | | disassoiate => disassociate nmaes => names mutiually => mutually aviod => avoid CLustering => Clustering availble => available Change-Id: I84545bf46acfccc9dde3e85020700edb5a8375a6
* Add a document for required optionsHuanxuan Ao2016-08-021-0/+30
| | | | | | | Some options are required in some commands, I think we need a document to state what should we do in this case. Change-Id: Id345ca1790e2125b333b271b74288e1a73d39ba3
* Clarification of option name rulesDean Troyer2016-07-221-0/+6
| | | | | | We never specifcally said anywhere that short names are global only and why. Change-Id: Ia2824cb7ebe7c2e1d116c0a9bc7760de24904c61
* Add describe of overwrite options behavior into devrefRui Chen2016-05-031-7/+26
| | | | | | | | Update the devref to add the describe and code example about overwrite options behavior. Change-Id: I65e9a3a30acf8d427906096bde24fa8b4c3ac3f7 Implements: blueprint allow-overwrite-set-options
* Devref: Options with Multiple ValuesRichard Theis2016-03-311-0/+81
| | | | | | Add a devref for options with multiple values. Change-Id: Ic90c2317eb6c0445d234964c5243ecc689d5f4c7
* Trivial-Fix : Add a ' to the choices documentationreedip2016-03-181-1/+1
| | | | Change-Id: Ic2023e91602fa23512bc5cc9c6a395f2311adb1a
* Devref: Options with ChoicesRichard Theis2016-03-011-1/+33
| | | | | | | Add a developer reference for options with choices. This patch set also includes RST doc formatting fixes. Change-Id: I5fd6a699806edf1d2d95110f0b8a2b8a385028ab
* Fix 'code-block' tag format issuesRui Chen2016-03-011-14/+16
| | | | | | | Modify 'code-block' tag format so that the following python code could be showed exactly, and reformat the more than 79 chars of lines. Change-Id: Ic6721e4cc8f4c7a3e4a7c7dbd63d9089180cdc33
* Fix a spell typosvenkatamahesh2016-02-031-1/+1
| | | | Change-Id: I422fc8086af83efa4c04fd1951b4738404c1a1b7
* Add Command Options guideline docDean Troyer2015-10-211-0/+135
Add a developer guideline for command options to define the options used across multiple commands and make them behave consistently. Change-Id: I1dbbafe8061e10b271cd55cac056731508c52204
View Lorry Controller Status