From fcda5c2d1a8653242e580cc2c00d130a5d4f4e2e Mon Sep 17 00:00:00 2001 From: David Rabel Date: Fri, 2 Mar 2018 11:32:59 +0100 Subject: [PATCH] Fix indentation in doc/source/cli/* Current indentation was wrongly interpreted as quotes. Change-Id: I731d8833e69e6bed12f5637d6bb3248b890c18ab --- doc/source/cli/nova-api-metadata.rst | 4 +++- doc/source/cli/nova-api-os-compute.rst | 4 +++- doc/source/cli/nova-api.rst | 4 +++- doc/source/cli/nova-cells.rst | 4 +++- doc/source/cli/nova-compute.rst | 4 +++- doc/source/cli/nova-conductor.rst | 4 +++- doc/source/cli/nova-console.rst | 4 +++- doc/source/cli/nova-consoleauth.rst | 4 +++- doc/source/cli/nova-dhcpbridge.rst | 4 +++- doc/source/cli/nova-manage.rst | 26 ++++--------------------- doc/source/cli/nova-network.rst | 6 ++++-- doc/source/cli/nova-novncproxy.rst | 4 +++- doc/source/cli/nova-rootwrap.rst | 4 +++- doc/source/cli/nova-scheduler.rst | 4 +++- doc/source/cli/nova-serialproxy.rst | 4 +++- doc/source/cli/nova-spicehtml5proxy.rst | 4 +++- doc/source/cli/nova-status.rst | 3 ++- doc/source/cli/nova-xvpvncproxy.rst | 4 +++- 18 files changed, 55 insertions(+), 40 deletions(-) diff --git a/doc/source/cli/nova-api-metadata.rst b/doc/source/cli/nova-api-metadata.rst index 255e66ffe539..346f4fe485fa 100644 --- a/doc/source/cli/nova-api-metadata.rst +++ b/doc/source/cli/nova-api-metadata.rst @@ -16,6 +16,8 @@ Server for the Nova Metadata API Synopsis ======== +:: + nova-api-metadata [options] Description @@ -26,7 +28,7 @@ Description Options ======= - **General options** +**General options** Files ===== diff --git a/doc/source/cli/nova-api-os-compute.rst b/doc/source/cli/nova-api-os-compute.rst index adca6f48ca78..1ac435ac106e 100644 --- a/doc/source/cli/nova-api-os-compute.rst +++ b/doc/source/cli/nova-api-os-compute.rst @@ -16,6 +16,8 @@ Server for the Nova OpenStack Compute APIs Synopsis ======== +:: + nova-api-os-compute [options] Description @@ -27,7 +29,7 @@ API Options ======= - **General options** +**General options** Files ===== diff --git a/doc/source/cli/nova-api.rst b/doc/source/cli/nova-api.rst index 20854963ec1a..8680b1ec3e71 100644 --- a/doc/source/cli/nova-api.rst +++ b/doc/source/cli/nova-api.rst @@ -16,6 +16,8 @@ Server for the OpenStack Compute APIs Synopsis ======== +:: + nova-api [options] Description @@ -27,7 +29,7 @@ separate greenthreads Options ======= - **General options** +**General options** Files ===== diff --git a/doc/source/cli/nova-cells.rst b/doc/source/cli/nova-cells.rst index 04779c5b8480..e67d925f7c98 100644 --- a/doc/source/cli/nova-cells.rst +++ b/doc/source/cli/nova-cells.rst @@ -16,6 +16,8 @@ Server for the Nova Cells Synopsis ======== +:: + nova-cells [options] Description @@ -34,7 +36,7 @@ for new instances. Options ======= - **General options** +**General options** Files ===== diff --git a/doc/source/cli/nova-compute.rst b/doc/source/cli/nova-compute.rst index 14b7a189dd83..d1a340d46573 100644 --- a/doc/source/cli/nova-compute.rst +++ b/doc/source/cli/nova-compute.rst @@ -16,6 +16,8 @@ Nova Compute Server Synopsis ======== +:: + nova-compute [options] Description @@ -29,7 +31,7 @@ state, attaching persistent storage, and terminating the instance. Options ======= - **General options** +**General options** Files ===== diff --git a/doc/source/cli/nova-conductor.rst b/doc/source/cli/nova-conductor.rst index 0cb1664a5d49..377765fc2b43 100644 --- a/doc/source/cli/nova-conductor.rst +++ b/doc/source/cli/nova-conductor.rst @@ -16,6 +16,8 @@ Server for the Nova Conductor Synopsis ======== +:: + nova-conductor [options] Description @@ -27,7 +29,7 @@ which provides coordination and database query support for Nova. Options ======= - **General options** +**General options** Files ===== diff --git a/doc/source/cli/nova-console.rst b/doc/source/cli/nova-console.rst index 6108064e1d73..5c4e2d255dcc 100644 --- a/doc/source/cli/nova-console.rst +++ b/doc/source/cli/nova-console.rst @@ -16,6 +16,8 @@ Nova Console Server Synopsis ======== +:: + nova-console [options] Description @@ -27,7 +29,7 @@ is a console proxy to set up multi-tenant VM console access, e.g. with `XVP`. Options ======= - **General options** +**General options** Files ===== diff --git a/doc/source/cli/nova-consoleauth.rst b/doc/source/cli/nova-consoleauth.rst index 857e0e508926..48125111f17b 100644 --- a/doc/source/cli/nova-consoleauth.rst +++ b/doc/source/cli/nova-consoleauth.rst @@ -16,6 +16,8 @@ Nova Console Authentication Server Synopsis ======== +:: + nova-consoleauth [options] Description @@ -27,7 +29,7 @@ service, which provides authentication for Nova consoles. Options ======= - **General options** +**General options** Files ===== diff --git a/doc/source/cli/nova-dhcpbridge.rst b/doc/source/cli/nova-dhcpbridge.rst index cf9d8923092d..8c0b22bd21cc 100644 --- a/doc/source/cli/nova-dhcpbridge.rst +++ b/doc/source/cli/nova-dhcpbridge.rst @@ -16,6 +16,8 @@ Handles Lease Database updates from DHCP servers Synopsis ======== +:: + nova-dhcpbridge [options] Description @@ -31,7 +33,7 @@ and flatDHCP). `nova-dhcpbridge` should not be run as a daemon. Options ======= - **General options** +**General options** Files ===== diff --git a/doc/source/cli/nova-manage.rst b/doc/source/cli/nova-manage.rst index 36f6fe189d60..ccca7f9b7ef7 100644 --- a/doc/source/cli/nova-manage.rst +++ b/doc/source/cli/nova-manage.rst @@ -16,6 +16,8 @@ Control and manage cloud computer instances Synopsis ======== +:: + nova-manage [] Description @@ -46,11 +48,9 @@ Nova Database ~~~~~~~~~~~~~ ``nova-manage db version`` - Print the current main database version. ``nova-manage db sync [--version ] [--local_cell]`` - Upgrade the main database schema up to the most recent version or ``--version`` if specified. By default, this command will also attempt to upgrade the schema for the cell0 database if it is mapped (see the @@ -61,7 +61,6 @@ Nova Database nova-manage. ``nova-manage db archive_deleted_rows [--max_rows ] [--verbose] [--until-complete] [--purge]`` - Move deleted rows from production tables to shadow tables. Note that the corresponding rows in the instance_mappings and request_specs tables of the API database are purged when instance records are archived. Specifying @@ -74,7 +73,6 @@ Nova Database `` manually after archiving is complete. ``nova-manage db purge [--all] [--before ] [--verbose] [--all-cells]`` - Delete rows from shadow tables. Specifying --all will delete all data from all shadow tables. Specifying --before will delete data from all shadow tables that is older than the date provided. Date strings may be fuzzy, such as @@ -86,11 +84,9 @@ Nova Database data was deleted, 4 if the list of cells cannot be obtained. ``nova-manage db null_instance_uuid_scan [--delete]`` - Lists and optionally deletes database records where instance_uuid is NULL. ``nova-manage db online_data_migrations [--max-count]`` - Perform data migration to update all live data. Return exit code 0 if migrations were successful or exit code 1 for partial updates. This command should be called after upgrading database schema and nova services on all @@ -102,7 +98,6 @@ Nova Database complete. ``nova-manage db ironic_flavor_migration [--all] [--host] [--node] [--resource_class]`` - Perform the ironic flavor migration process against the database while services are offline. This is `not recommended` for most people. The ironic compute driver will do this online and as @@ -131,12 +126,11 @@ Nova API Database ~~~~~~~~~~~~~~~~~ ``nova-manage api_db version`` - Print the current cells api database version. ``nova-manage api_db sync`` - - Sync the api cells database up to the most recent version. This is the standard way to create the db as well. + Sync the api cells database up to the most recent version. This is the + standard way to create the db as well. .. _man-page-cells-v2: @@ -144,7 +138,6 @@ Nova Cells v2 ~~~~~~~~~~~~~ ``nova-manage cell_v2 simple_cell_setup [--transport-url ]`` - Setup a fresh cells v2 environment; this should not be used if you currently have a cells v1 environment. Returns 0 if setup is completed (or has already been done), 1 if no hosts are reporting (and cannot be @@ -152,7 +145,6 @@ Nova Cells v2 and 2 if run in a cells v1 environment. ``nova-manage cell_v2 map_cell0 [--database_connection ]`` - Create a cell mapping to the database connection for the cell0 database. If a database_connection is not specified, it will use the one defined by ``[database]/connection`` in the configuration file passed to nova-manage. @@ -162,7 +154,6 @@ Nova Cells v2 successfully or already setup. ``nova-manage cell_v2 map_instances --cell_uuid [--max-count ]`` - Map instances to the provided cell. Instances in the nova database will be queried from oldest to newest and mapped to the provided cell. A max_count can be set on the number of instance to map in a single run. @@ -176,7 +167,6 @@ Nova Cells v2 specifying a custom value and run the command until it exits with 0. ``nova-manage cell_v2 map_cell_and_hosts [--name ] [--transport-url ] [--verbose]`` - Create a cell mapping to the database connection and message queue transport url, and map hosts to that cell. The database connection comes from the ``[database]/connection`` defined in the configuration @@ -187,7 +177,6 @@ Nova Cells v2 on successful completion, and 1 if the transport url is missing. ``nova-manage cell_v2 verify_instance --uuid [--quiet]`` - Verify instance mapping to a cell. This command is useful to determine if the cells v2 environment is properly setup, specifically in terms of the cell, host, and instance mapping records required. Returns 0 when the @@ -200,7 +189,6 @@ Nova Cells v2 which still has an instance mapping. ``nova-manage cell_v2 create_cell [--name ] [--transport-url ] [--database_connection ] [--verbose]`` - Create a cell mapping to the database connection and message queue transport url. If a database_connection is not specified, it will use the one defined by ``[database]/connection`` in the configuration file passed @@ -212,7 +200,6 @@ Nova Cells v2 transport url and database connection combination. ``nova-manage cell_v2 discover_hosts [--cell_uuid ] [--verbose] [--strict]`` - Searches cells, or a single cell, and maps found hosts. This command will check the database for each cell (or a single one if passed in) and map any hosts which are not currently mapped. If a host is already mapped nothing @@ -224,13 +211,11 @@ Nova Cells v2 code 1). ``nova-manage cell_v2 list_cells [--verbose]`` - Lists the v2 cells in the deployment. By default only the cell name and uuid are shown. Use the --verbose option to see transport url and database connection details. ``nova-manage cell_v2 delete_cell [--force] --cell_uuid `` - Delete a cell by the given uuid. Returns 0 if the empty cell is found and deleted successfully or the cell that has hosts is found and the cell, hosts and the instance_mappings are deleted successfully with ``--force`` option @@ -242,14 +227,12 @@ Nova Cells v2 again without the ``--force`` option. ``nova-manage cell_v2 list_hosts [--cell_uuid ]`` - Lists the hosts in one or all v2 cells. By default hosts in all v2 cells are listed. Use the --cell_uuid option to list hosts in a specific cell. If the cell is not found by uuid, this command will return an exit code of 1. Otherwise, the exit code will be 0. ``nova-manage cell_v2 update_cell --cell_uuid [--name ] [--transport-url ] [--database_connection ]`` - Updates the properties of a cell by the given uuid. If a database_connection is not specified, it will attempt to use the one defined by ``[database]/connection`` in the configuration file. If a @@ -267,7 +250,6 @@ Nova Cells v2 values. Use caution when changing these values. ``nova-manage cell_v2 delete_host --cell_uuid --host `` - Delete a host by the given host name and the given cell uuid. Returns 0 if the empty host is found and deleted successfully, 1 if a cell with that uuid could not be found, 2 if a host with that name could not be diff --git a/doc/source/cli/nova-network.rst b/doc/source/cli/nova-network.rst index 3aca800afe71..ac69e6ad7ef0 100644 --- a/doc/source/cli/nova-network.rst +++ b/doc/source/cli/nova-network.rst @@ -16,7 +16,9 @@ Nova Network Server Synopsis ======== - nova-network [options] +:: + + nova-network [options] Description =========== @@ -32,7 +34,7 @@ is responsible for allocating IPs and setting up the network Options ======= - **General options** +**General options** Files ===== diff --git a/doc/source/cli/nova-novncproxy.rst b/doc/source/cli/nova-novncproxy.rst index 1bdfb437201a..eeb1cbda4a9a 100644 --- a/doc/source/cli/nova-novncproxy.rst +++ b/doc/source/cli/nova-novncproxy.rst @@ -16,6 +16,8 @@ Websocket novnc Proxy for OpenStack Nova noVNC consoles Synopsis ======== +:: + nova-novncproxy [options] Description @@ -28,7 +30,7 @@ Nova noVNC consoles. Options ======= - **General options** +**General options** Files ===== diff --git a/doc/source/cli/nova-rootwrap.rst b/doc/source/cli/nova-rootwrap.rst index 0983dc24cca5..4bba4799c390 100644 --- a/doc/source/cli/nova-rootwrap.rst +++ b/doc/source/cli/nova-rootwrap.rst @@ -16,6 +16,8 @@ Root wrapper for Nova Synopsis ======== +:: + nova-rootwrap [options] Description @@ -44,7 +46,7 @@ To make allowed commands node-specific, your packaging should only install Options ======= - **General options** +**General options** Files ===== diff --git a/doc/source/cli/nova-scheduler.rst b/doc/source/cli/nova-scheduler.rst index d2b6ac48fd1d..80334a2ccde6 100644 --- a/doc/source/cli/nova-scheduler.rst +++ b/doc/source/cli/nova-scheduler.rst @@ -16,6 +16,8 @@ Nova Scheduler Synopsis ======== +:: + nova-scheduler [options] Description @@ -27,7 +29,7 @@ which is responsible for picking a compute node to run a given instance on. Options ======= - **General options** +**General options** Files ===== diff --git a/doc/source/cli/nova-serialproxy.rst b/doc/source/cli/nova-serialproxy.rst index f53448170be3..9855fa72cc54 100644 --- a/doc/source/cli/nova-serialproxy.rst +++ b/doc/source/cli/nova-serialproxy.rst @@ -16,6 +16,8 @@ Websocket serial Proxy for OpenStack Nova serial ports Synopsis ======== +:: + nova-serialproxy [options] Description @@ -28,7 +30,7 @@ OpenStack Nova serial ports. Options ======= - **General options** +**General options** Files ===== diff --git a/doc/source/cli/nova-spicehtml5proxy.rst b/doc/source/cli/nova-spicehtml5proxy.rst index f6365cfea8eb..42d28eca6720 100644 --- a/doc/source/cli/nova-spicehtml5proxy.rst +++ b/doc/source/cli/nova-spicehtml5proxy.rst @@ -16,6 +16,8 @@ Websocket Proxy for OpenStack Nova SPICE HTML5 consoles Synopsis ======== +:: + nova-spicehtml5proxy [options] Description @@ -28,7 +30,7 @@ with OpenStack Nova SPICE HTML5 consoles. Options ======= - **General options** +**General options** Files ===== diff --git a/doc/source/cli/nova-status.rst b/doc/source/cli/nova-status.rst index cd145f6ab8d3..8eaced691f23 100644 --- a/doc/source/cli/nova-status.rst +++ b/doc/source/cli/nova-status.rst @@ -16,6 +16,8 @@ CLI interface for nova status commands Synopsis ======== +:: + nova-status [] Description @@ -53,7 +55,6 @@ Upgrade ~~~~~~~ ``nova-status upgrade check`` - Performs a release-specific readiness check before restarting services with new code. This command expects to have complete configuration and access to databases and services within a cell. For example, this check may query diff --git a/doc/source/cli/nova-xvpvncproxy.rst b/doc/source/cli/nova-xvpvncproxy.rst index f725397d2e89..a2a9cb8e48e5 100644 --- a/doc/source/cli/nova-xvpvncproxy.rst +++ b/doc/source/cli/nova-xvpvncproxy.rst @@ -16,6 +16,8 @@ XVP VNC Console Proxy Server Synopsis ======== +:: + nova-xvpvncproxy [options] Description @@ -28,7 +30,7 @@ Xen hypervisor. Options ======= - **General options** +**General options** Files =====