Skip to content

Commit 5309bf5

Browse files
author
Dean Troyer
committed
Merge remote-tracking branch 'origin/master' into f4-merge-branch
Change-Id: Ie6c321e67aa9338334e4649879e60847a5d1eb56
2 parents 5e5239d + f63bb18 commit 5309bf5

File tree

78 files changed

+7838
-1860
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

78 files changed

+7838
-1860
lines changed

‎doc/source/_extra/.htaccess‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Redirect docs from the old to new location following the Great Docs Migration of 2017
2+
3+
redirectmatch 301 ^/python-openstackclient/([^/]+)/command-objects/([^/.]+).html$ /python-openstackclient/$1/cli/command-objects/$2.html
4+
5+
redirectmatch 301 ^/python-openstackclient/([^/]+)/authentication.html$ /python-openstackclient/$1/cli/authentication.html
6+
redirectmatch 301 ^/python-openstackclient/([^/]+)/backward-incompatible.html$ /python-openstackclient/$1/cli/backward-incompatible.html
7+
redirectmatch 301 ^/python-openstackclient/([^/]+)/command-list.html$ /python-openstackclient/$1/cli/command-list.html
8+
redirectmatch 301 ^/python-openstackclient/([^/]+)/commands.html$ /python-openstackclient/$1/cli/commands.html
9+
redirectmatch 301 ^/python-openstackclient/([^/]+)/decoder.html$ /python-openstackclient/$1/cli/decoder.html
10+
redirectmatch 301 ^/python-openstackclient/([^/]+)/interactive.html$ /python-openstackclient/$1/cli/interactive.html
11+
redirectmatch 301 ^/python-openstackclient/([^/]+)/plugin-commands.html$ /python-openstackclient/$1/cli/plugin-commands.html
12+
13+
redirectmatch 301 ^/python-openstackclient/([^/]+)/specs/([^/.]+).html$ /python-openstackclient/$1/contributor/specs/$2.html
14+
15+
redirectmatch 301 ^/python-openstackclient/([^/]+)/command-beta.html$ /python-openstackclient/$1/contributor/command-beta.html
16+
redirectmatch 301 ^/python-openstackclient/([^/]+)/command-errors.html$ /python-openstackclient/$1/contributor/command-errors.html
17+
redirectmatch 301 ^/python-openstackclient/([^/]+)/command-logs.html$ /python-openstackclient/$1/contributor/command-logs.html
18+
redirectmatch 301 ^/python-openstackclient/([^/]+)/command-options.html$ /python-openstackclient/$1/contributor/command-options.html
19+
redirectmatch 301 ^/python-openstackclient/([^/]+)/command-wrappers.html$ /python-openstackclient/$1/contributor/command-wrappers.html
20+
redirectmatch 301 ^/python-openstackclient/([^/]+)/developing.html$ /python-openstackclient/$1/contributor/developing.html
21+
redirectmatch 301 ^/python-openstackclient/([^/]+)/humaninterfaceguide.html$ /python-openstackclient/$1/contributor/humaninterfaceguide.html
22+
redirectmatch 301 ^/python-openstackclient/([^/]+)/plugins.html$ /python-openstackclient/$1/contributor/plugins.html

‎doc/source/cli/command-objects/container.rst‎

Lines changed: 15 additions & 139 deletions
Original file line numberDiff line numberDiff line change
@@ -2,149 +2,25 @@
22
container
33
=========
44

5-
Object Storage v1
5+
A **container** defines a namespace for **objects**. Applies to Object Storage v1
66

7-
container create
8-
----------------
7+
.. autoprogram-cliff:: openstack.object_store.v1
8+
:command: container create
99

10-
Create new container
10+
.. autoprogram-cliff:: openstack.object_store.v1
11+
:command: container delete
1112

12-
.. program:: container create
13-
.. code:: bash
13+
.. autoprogram-cliff:: openstack.object_store.v1
14+
:command: container list
1415

15-
openstack container create
16-
<container-name> [<container-name> ...]
16+
.. autoprogram-cliff:: openstack.object_store.v1
17+
:command: container save
1718

18-
.. describe:: <container-name>
19+
.. autoprogram-cliff:: openstack.object_store.v1
20+
:command: container set
1921

20-
New container name(s)
22+
.. autoprogram-cliff:: openstack.object_store.v1
23+
:command: container show
2124

22-
container delete
23-
----------------
24-
25-
Delete container
26-
27-
.. program:: container delete
28-
.. code:: bash
29-
30-
openstack container delete
31-
[-r] | [--recursive]
32-
<container> [<container> ...]
33-
34-
.. option:: --recursive, -r
35-
36-
Recursively delete objects in container before container delete
37-
38-
.. describe:: <container>
39-
40-
Container(s) to delete
41-
42-
container list
43-
--------------
44-
45-
List containers
46-
47-
.. program:: container list
48-
.. code:: bash
49-
50-
openstack container list
51-
[--prefix <prefix>]
52-
[--marker <marker>]
53-
[--end-marker <end-marker>]
54-
[--limit <num-containers>]
55-
[--long]
56-
[--all]
57-
58-
.. option:: --prefix <prefix>
59-
60-
Filter list using <prefix>
61-
62-
.. option:: --marker <marker>
63-
64-
Anchor for paging
65-
66-
.. option:: --end-marker <end-marker>
67-
68-
End anchor for paging
69-
70-
.. option:: --limit <num-containers>
71-
72-
Limit the number of containers returned
73-
74-
.. option:: --long
75-
76-
List additional fields in output
77-
78-
.. option:: --all
79-
80-
List all containers (default is 10000)
81-
82-
container save
83-
--------------
84-
85-
Save container contents locally
86-
87-
.. program:: container save
88-
.. code:: bash
89-
90-
openstack container save
91-
<container>
92-
93-
.. describe:: <container>
94-
95-
Container to save
96-
97-
container set
98-
-------------
99-
100-
Set container properties
101-
102-
.. program:: container set
103-
.. code:: bash
104-
105-
openstack container set
106-
[--property <key=value> [...] ]
107-
<container>
108-
109-
.. option:: --property <key=value>
110-
111-
Set a property on this container (repeat option to set multiple properties)
112-
113-
.. describe:: <container>
114-
115-
Container to modify
116-
117-
container show
118-
--------------
119-
120-
Display container details
121-
122-
.. program:: container show
123-
.. code:: bash
124-
125-
openstack container show
126-
<container>
127-
128-
.. describe:: <container>
129-
130-
Container to display
131-
132-
container unset
133-
---------------
134-
135-
Unset container properties
136-
137-
.. program:: container unset
138-
.. code:: bash
139-
140-
openstack container unset
141-
[--property <key>]
142-
<container>
143-
144-
.. option:: --property <key>
145-
146-
Property to remove from container (repeat option to remove multiple properties)
147-
148-
.. describe:: <container>
149-
150-
Container to modify
25+
.. autoprogram-cliff:: openstack.object_store.v1
26+
:command: container unset

‎doc/source/cli/command-objects/image.rst‎

Lines changed: 37 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ Associate project with image
1616
1717
openstack image add project
1818
[--project-domain <project-domain>]
19-
<image> <project>
19+
<image>
20+
<project>
2021
2122
.. option:: --project-domain <project-domain>
2223

@@ -60,7 +61,8 @@ Create/upload an image
6061
[--public | --private | --community | --shared]
6162
[--property <key=value> [...] ]
6263
[--tag <tag> [...] ]
63-
[--project <project> [--project-domain <project-domain>]]
64+
[--project <project>]
65+
[--project-domain <project-domain>]
6466
<image-name>
6567
6668
.. option:: --id <id>
@@ -153,11 +155,11 @@ Create/upload an image
153155

154156
.. option:: --property <key=value>
155157

156-
Set a property on this image (repeat for multiple values)
158+
Set a property on this image (repeat option to set multiple properties)
157159

158160
.. option:: --tag <tag>
159161

160-
Set a tag on this image (repeat for multiple values)
162+
Set a tag on this image (repeat option to set multiple tags)
161163

162164
.. versionadded:: 2
163165

@@ -205,13 +207,12 @@ List available images
205207
openstack image list
206208
[--public | --private | --shared]
207209
[--property <key=value>]
210+
[--name <name>]
211+
[--status <status>]
208212
[--long]
209213
[--sort <key>[:<direction>]]
210214
[--limit <num-images>]
211215
[--marker <image>]
212-
[--name <name>]
213-
[--status <status>]
214-
215216
216217
.. option:: --public
217218
@@ -231,6 +232,18 @@ List available images
231232
232233
Filter output based on property
233234
235+
.. option:: --name <name>
236+
237+
Filter images based on name
238+
239+
*Image version 2 only.*
240+
241+
.. option:: --status <status>
242+
243+
Filter images based on status
244+
245+
*Image version 2 only*
246+
234247
.. option:: --long
235248
236249
List additional fields in output
@@ -251,15 +264,6 @@ List available images
251264
The last image of the previous page. Display list of images
252265
after marker. Display all images if not specified. (name or ID)
253266
254-
.. option:: --name <name>
255-
256-
Filter images based on name
257-
258-
.. option:: --status <status>
259-
260-
Filter images based on status
261-
262-
263267
*Image version 2 only*
264268
265269
image remove project
@@ -272,7 +276,7 @@ Disassociate project with image
272276
.. program:: image remove project
273277
.. code:: bash
274278
275-
openstack image remove remove
279+
openstack image remove project
276280
[--project-domain <project-domain>]
277281
<image>
278282
<project>
@@ -347,8 +351,9 @@ Set image properties
347351
[--os-distro <os-distro>]
348352
[--os-version <os-version>]
349353
[--ramdisk-id <ramdisk-id>]
350-
[--activate|--deactivate]
351-
[--project <project> [--project-domain <project-domain>]]
354+
[--deactivate | --activate]
355+
[--project <project>]
356+
[--project-domain <project-domain>]
352357
[--accept | --reject | --pending]
353358
<image>
354359
@@ -460,7 +465,7 @@ Set image properties
460465
461466
.. option:: --tag <tag>
462467
463-
Set a tag on this image (repeat for multiple values)
468+
Set a tag on this image (repeat option to set multiple tags)
464469
465470
.. versionadded:: 2
466471
@@ -500,15 +505,15 @@ Set image properties
500505
501506
.. versionadded:: 2
502507
503-
.. option:: --activate
508+
.. option:: --deactivate
504509
505-
Activate the image.
510+
Deactivate the image.
506511
507512
.. versionadded:: 2
508513
509-
.. option:: --deactivate
514+
.. option:: --activate
510515
511-
Deactivate the image.
516+
Activate the image.
512517
513518
.. versionadded:: 2
514519
@@ -568,8 +573,13 @@ Display image details
568573
.. code:: bash
569574
570575
openstack image show
576+
[--human-readable]
571577
<image>
572578
579+
.. option:: --human-readable
580+
581+
Print image size in a human-friendly format.
582+
573583
.. _image_show-image:
574584
.. describe:: <image>
575585
@@ -585,16 +595,16 @@ Unset image tags or properties
585595
.. program:: image unset
586596
.. code:: bash
587597
588-
openstack image set
598+
openstack image unset
589599
[--tag <tag>]
590-
[--property <property>]
600+
[--property <property-key>]
591601
<image>
592602
593603
.. option:: --tag <tag>
594604
595605
Unset a tag on this image (repeat option to unset multiple tags)
596606
597-
.. option:: --property <property>
607+
.. option:: --property <property-key>
598608
599609
Unset a property on this image (repeat option to unset multiple properties)
600610

0 commit comments

Comments
 (0)