11 Commits

Author SHA1 Message Date
Rui Chen
29f78500db Redefine set/unset command devref
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
2016-10-10 09:36:47 +08:00
Atsushi SAKAI
c97e8187fe Fix six typos
disassoiate => disassociate
nmaes       => names
mutiually   => mutually
aviod       => avoid
CLustering  => Clustering
availble    => available

Change-Id: I84545bf46acfccc9dde3e85020700edb5a8375a6
2016-08-25 19:54:24 +09:00
Huanxuan Ao
c1a040f66d Add a document for required options
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
2016-08-02 19:54:30 +08:00
Dean Troyer
75a1fcf70a Clarification of option name rules
We never specifcally said anywhere that short names are global only and why.

Change-Id: Ia2824cb7ebe7c2e1d116c0a9bc7760de24904c61
2016-07-22 12:58:28 -05:00
Rui Chen
403e6cad5e Add describe of overwrite options behavior into devref
Update the devref to add the describe and code example about
overwrite options behavior.

Change-Id: I65e9a3a30acf8d427906096bde24fa8b4c3ac3f7
Implements: blueprint allow-overwrite-set-options
2016-05-03 03:20:33 +00:00
Richard Theis
8ba257cb30 Devref: Options with Multiple Values
Add a devref for options with multiple values.

Change-Id: Ic90c2317eb6c0445d234964c5243ecc689d5f4c7
2016-03-31 08:55:56 -05:00
reedip
3ccc4f7d06 Trivial-Fix : Add a ' to the choices documentation
Change-Id: Ic2023e91602fa23512bc5cc9c6a395f2311adb1a
2016-03-18 06:25:31 +00:00
Richard Theis
fbe5dc657b Devref: Options with Choices
Add a developer reference for options with choices. This patch set
also includes RST doc formatting fixes.

Change-Id: I5fd6a699806edf1d2d95110f0b8a2b8a385028ab
2016-03-01 09:31:43 -06:00
Rui Chen
c832e2a771 Fix 'code-block' tag format issues
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
2016-03-01 08:48:47 +00:00
venkatamahesh
65007432dc Fix a spell typos
Change-Id: I422fc8086af83efa4c04fd1951b4738404c1a1b7
2016-02-03 15:47:25 +05:30
Dean Troyer
46fdaaba6b Add Command Options guideline doc
Add a developer guideline for command options to define the options
used across multiple commands and make them behave consistently.

Change-Id: I1dbbafe8061e10b271cd55cac056731508c52204
2015-10-21 09:20:00 -05:00