openstack/glance
Code Issues Proposed changes

Correct sphinx syntax of glance doc

Browse Source 
Change-Id: I0050ef32196e8ea73ef50837c27bf9e67727d1af
This commit is contained in:
Rui Yuan Dou 2017-08-21 16:11:53 +08:00
parent c05aeb8226
commit 914bf760fb
11 changed files with 22 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/source/admin/controllingservers.rst
View File

@ -182,7 +182,7 @@ a configuration file when starting the server.
In order for your launched glance service to be monitored for unexpected death
and respawned if necessary, use the following option:
and respawned if necessary, use the following option::
$ sudo glance-control [service] start --respawn ...
@ -194,7 +194,7 @@ services (where process death occurred within one second of the last launch).
By default, output from glance services is discarded when launched with ``glance-control``.
In order to capture such output via syslog, use the following option:
In order to capture such output via syslog, use the following option::
$ sudo glance-control --capture-output ...

5
doc/source/admin/db-sqlalchemy-migrate.rst
View File

@ -27,13 +27,14 @@ The default metadata driver for Glance uses sqlalchemy, which implies there
exists a backend database which must be managed. The ``glance-manage`` binary
provides a set of commands for making this easier.
The commands should be executed as a subcommand of 'db':
The commands should be executed as a subcommand of 'db'::
glance-manage db <cmd> <args>
Sync the Database
-----------------
::
glance-manage db sync <version> <current_version>
@ -42,6 +43,7 @@ Place a database under migration control and upgrade, creating it first if neces
Determining the Database Version
--------------------------------
::
glance-manage db version
@ -50,6 +52,7 @@ This will print the current migration level of a Glance database.
Upgrading an Existing Database
------------------------------
::
glance-manage db upgrade <VERSION>

5
doc/source/admin/db.rst
View File

@ -20,7 +20,7 @@ The default metadata driver for Glance uses `SQLAlchemy`_, which implies there
exists a backend database which must be managed. The ``glance-manage`` binary
provides a set of commands for making this easier.
The commands should be executed as a subcommand of 'db':
The commands should be executed as a subcommand of 'db'::
glance-manage db <cmd> <args>
@ -77,6 +77,7 @@ migrations:
Sync the Database
-----------------
::
glance-manage db sync [VERSION]
@ -100,6 +101,7 @@ specified VERSION or to the latest migration level if VERSION is not specified.
Determining the Database Version
--------------------------------
::
glance-manage db version
@ -108,6 +110,7 @@ This will print the current migration level of a Glance database.
Upgrading an Existing Database
------------------------------
::
glance-manage db upgrade [VERSION]

1
doc/source/admin/index.rst
View File

@ -9,7 +9,6 @@
cache
policies
property-protections
requirements
apache-httpd
notifications
tasks

16
doc/source/admin/rollingupgrades.rst
View File

@ -79,13 +79,13 @@ Following is the process to upgrade Glance with zero downtime:
accordingly. **DO NOT** start the Glance services on the NEW NODE at
this time.
4. Using the NEW NODE, expand the database using the command
4. Using the NEW NODE, expand the database using the command::
``glance-manage db expand``.
glance-manage db expand
5. Then, also on the NEW NODE, perform the data migrations using the command
5. Then, also on the NEW NODE, perform the data migrations using the command::
``glance-manage db migrate``.
glance-manage db migrate
*The data migrations must be completed before you proceed to the next step.*
@ -104,9 +104,7 @@ Following is the process to upgrade Glance with zero downtime:
8. After **ALL** of the nodes have been upgraded to run the new Glance
services, and there are **NO** nodes running any old Glance services,
contract the database by running the command
``glance manage db contract``
from any one of the upgraded nodes.
contract the database by running the command from any one of the upgraded
nodes::
glance manage db contract

3
doc/source/admin/zero-downtime-db-upgrade.rst
View File

@ -106,6 +106,7 @@ following operations.
Expanding the Database
----------------------
::
glance-manage db expand
@ -116,6 +117,7 @@ any new services are started.
Migrating the Data
------------------
::
glance-manage db migrate
@ -126,6 +128,7 @@ are started.
Contracting the Database
------------------------
::
glance-manage db contract

1
doc/source/cli/footer.txt
View File

@ -1,4 +1,3 @@
.. -*- mode: rst -*-
SEE ALSO
========

1
doc/source/cli/general_options.txt
View File

@ -1,4 +1,3 @@
.. -*- mode: rst -*-
**-h, --help**
Show the help message and exit

1
doc/source/cli/header.txt
View File

@ -1,4 +1,3 @@
.. -*- mode: rst -*-
:Author: glance@lists.launchpad.net
:Date: 2017-09-15

1
doc/source/cli/openstack_options.txt
View File

@ -1,4 +1,3 @@
.. -*- mode: rst -*-
**-os-auth-token=OS_AUTH_TOKEN**
Defaults to env[OS_AUTH_TOKEN]

4
doc/source/configuration/configuring.rst
View File

@ -1,4 +1,4 @@
..
Copyright 2011 OpenStack Foundation
All Rights Reserved.
@ -113,7 +113,7 @@ Glance has a few command-line options that are common to all Glance programs:
If --config-dir is set, then --config-file is ignored.
An example usage would be:
An example usage would be::
$ glance-api --config-dir=/etc/glance/glance-api.d