openstack/senlin
Code Issues Proposed changes

Correct description about marker option in getting_started doc

Browse Source 
Some descriptions about 'marker' option of list operation in
getting_started document are incorrect. This patch fixes them.

Change-Id: I9ea14e26cf1e155c847495daecbb94f4422ef04a
This commit is contained in:
yanyanhu 2015-08-20 23:23:05 -04:00
parent ad8afb46de
commit d7c516ea9c
5 changed files with 16 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/source/getting_started/clusters.rst
View File

@ -122,10 +122,11 @@ clusters returned from Senlin server each time, using the option
| 2959122e | c1 | ACTIVE | 2015-05-05T13:27:28 | | 2959122e | c1 | ACTIVE | 2015-05-05T13:27:28 |
+----------+------+--------+---------------------+ +----------+------+--------+---------------------+
Another option you can specify is the ID of a cluster from which you want to Another option you can specify is the ID of a cluster after which you want to
see the returned list starts. In other words, you don't want to see those see the returned list starts. In other words, you don't want to see those
clusters with IDs that come before the one you specify. You can use the option clusters with IDs that is or come before the one you specify. You can use the
:option:`--marker <ID>` (or :option:`-m <ID>`) for this purpose. For example:: option :option:`--marker <ID>` (or :option:`-m <ID>`) for this purpose. For
example::
$ senlin profile-list -l 1 -m 2959122e-11c7-4e82-b12f-f49dc5dac270 $ senlin profile-list -l 1 -m 2959122e-11c7-4e82-b12f-f49dc5dac270
+----------+------+--------+---------------------+ +----------+------+--------+---------------------+

4
doc/source/getting_started/membership.rst
View File

@ -68,10 +68,10 @@ example, the following command will list all nodes that were members of the
If the cluster size is very large, you may want to list the nodes in pages. If the cluster size is very large, you may want to list the nodes in pages.
This can be achieved by using the :option:`--marker` (or :option:`-m`) option This can be achieved by using the :option:`--marker` (or :option:`-m`) option
together with the :option:`--limit` (or :option:`-l`) option. The ``marker`` together with the :option:`--limit` (or :option:`-l`) option. The ``marker``
option value specifies a node ID from which you want the resulted list to option value specifies a node ID after which you want the resulted list to
start; and the ``limit`` option value specifies the number of nodes you want start; and the ``limit`` option value specifies the number of nodes you want
to include in the resulted list. For example, the following command lists the to include in the resulted list. For example, the following command lists the
nodes starting with a specific node ID with the length of the list set to 10:: nodes starting behind a specific node ID with the length of the list set to 10::
$ senlin cluster-node-list -m b28692a5-2536-4921-985b-1142d6045e1f -l 10 webservers $ senlin cluster-node-list -m b28692a5-2536-4921-985b-1142d6045e1f -l 10 webservers

7
doc/source/getting_started/nodes.rst
View File

@ -114,10 +114,11 @@ returned from Senlin server each time, using the option :option:`--limit
$ senlin node-list --limit 1 $ senlin node-list --limit 1
Another option you can specify is the ID of a node from which you want to Another option you can specify is the ID of a node after which you want to
see the returned list starts. In other words, you don't want to see those see the returned list starts. In other words, you don't want to see those
nodes with IDs that come before the one you specify. You can use the option nodes with IDs that is or come before the one you specify. You can use the
:option:`--marker <ID>` (or :option:`-m <ID>`) for this purpose. For example:: option :option:`--marker <ID>` (or :option:`-m <ID>`) for this purpose. For
example::
$ senlin node-list --marker <NODE ID HERE> $ senlin node-list --marker <NODE ID HERE>

7
doc/source/getting_started/policies.rst
View File

@ -69,10 +69,11 @@ of policies returned from Senlin server, using the option :option:`--limit` (or
| 239d7212 | dp01 | DeletionPolicy | 0 | 0 | 2015-07-11T04:24:34 | | 239d7212 | dp01 | DeletionPolicy | 0 | 0 | 2015-07-11T04:24:34 |
+----------+------+----------------+-------+----------+---------------------+ +----------+------+----------------+-------+----------+---------------------+
Yet another option you can specify is the ID of a policy object from which Yet another option you can specify is the ID of a policy object after which
you want to see the list starts. In other words, you don't want to see those you want to see the list starts. In other words, you don't want to see those
policies with IDs that come before the one you specify. You can use the option policies with IDs that is or come before the one you specify. You can use the
:option:`--marker <ID>` (or option:`-m <ID>`) for this purpose. For example:: option :option:`--marker <ID>` (or option:`-m <ID>`) for this purpose. For
example::
$ senlin profile-list -l 1 -m 239d7212-6196-4a89-9446-44d28717d7de $ senlin profile-list -l 1 -m 239d7212-6196-4a89-9446-44d28717d7de

4
doc/source/getting_started/profiles.rst
View File

@ -77,9 +77,9 @@ number of profiles returned from Senlin server, using the option :option:`-l
| 560a8f9d | myserver | os.nova.server | 2015-05-05T13:26:00 | | 560a8f9d | myserver | os.nova.server | 2015-05-05T13:26:00 |
+----------+----------+----------------+---------------------+ +----------+----------+----------------+---------------------+
Yet another option you can specify is the ID of a profile object from which Yet another option you can specify is the ID of a profile object after which
you want to see the list starts. In other words, you don't want to see those you want to see the list starts. In other words, you don't want to see those
profiles with IDs that come before the one you specify. You can use the option profiles with IDs is or come before the one you specify. You can use the option
:option:`-m <ID>` (or :option:`--marker <ID>` for this purpose. For example:: :option:`-m <ID>` (or :option:`--marker <ID>` for this purpose. For example::
$ senlin profile-list -l 1 -m ceda64bd-70b7-4711-9526-77d5d51241c5 $ senlin profile-list -l 1 -m ceda64bd-70b7-4711-9526-77d5d51241c5