openstack/devstack
Code Issues Proposed changes

Fix configuration doc block formatting

Browse Source 
Many of the code blocks in the configuration documentation had extra
leading spaces. This resulted in the blocks being both code block
formatted as well as blockquoted in the output.

This patch removes leading spaces and some minor cleanup to get the
formatted output correct.

Change-Id: Ic4dfb49c547d51e16b673bc88d7b2b1a907e3258
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
This commit is contained in:
Sean McGinnis
2019-06-19 11:49:40 -05:00
parent fc9b41d733
commit f7302e1af1
1 changed files with 63 additions and 83 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
doc/source/configuration.rst
View File

@@ -230,16 +230,13 @@ proposal. ``GIT_BASE`` points to the primary repository server.
NOVA_BRANCH=master NOVA_BRANCH=master
To pull a branch directly from Gerrit, get the repo and branch from To pull a branch directly from Gerrit, get the repo and branch from
the Gerrit review page: the Gerrit review page::
:: git fetch https://review.openstack.org/p/openstack/nova \
refs/changes/50/5050/1 && git checkout FETCH_HEAD
git fetch https://review.openstack.org/p/openstack/nova refs/changes/50/5050/1 && git checkout FETCH_HEAD
The repo is the stanza following ``fetch`` and the branch is the The repo is the stanza following ``fetch`` and the branch is the
stanza following that: stanza following that::
::
NOVA_REPO=https://review.openstack.org/p/openstack/nova NOVA_REPO=https://review.openstack.org/p/openstack/nova
NOVA_BRANCH=refs/changes/50/5050/1 NOVA_BRANCH=refs/changes/50/5050/1
@@ -330,9 +327,7 @@ Database Backend
Multiple database backends are available. The available databases are defined Multiple database backends are available. The available databases are defined
in the lib/databases directory. in the lib/databases directory.
``mysql`` is the default database, choose a different one by putting the ``mysql`` is the default database, choose a different one by putting the
following in the ``localrc`` section: following in the ``localrc`` section::
::
disable_service mysql disable_service mysql
enable_service postgresql enable_service postgresql
@@ -347,9 +342,7 @@ backends may be available via external plugins. Enabling or disabling
RabbitMQ is handled via the usual service functions and RabbitMQ is handled via the usual service functions and
``ENABLED_SERVICES``. ``ENABLED_SERVICES``.
Example disabling RabbitMQ in ``local.conf``: Example disabling RabbitMQ in ``local.conf``::
::
disable_service rabbit disable_service rabbit
@@ -370,34 +363,23 @@ override toggle available that can be set in your ``local.conf``.
Keystone is run under Apache with ``mod_wsgi`` by default. Keystone is run under Apache with ``mod_wsgi`` by default.
Example (Keystone) Example (Keystone)::
::
KEYSTONE_USE_MOD_WSGI="True" KEYSTONE_USE_MOD_WSGI="True"
Example (Nova): Example (Nova)::
::
NOVA_USE_MOD_WSGI="True" NOVA_USE_MOD_WSGI="True"
Example (Swift): Example (Swift)::
::
SWIFT_USE_MOD_WSGI="True" SWIFT_USE_MOD_WSGI="True"
Example (Heat): Example (Heat)::
::
HEAT_USE_MOD_WSGI="True" HEAT_USE_MOD_WSGI="True"
Example (Cinder)::
Example (Cinder):
::
CINDER_USE_MOD_WSGI="True" CINDER_USE_MOD_WSGI="True"
@@ -565,9 +547,7 @@ address.
The default value for this setting is ``4``. Dual-mode support, for The default value for this setting is ``4``. Dual-mode support, for
example ``4+6`` is not currently supported. ``HOST_IPV6`` can example ``4+6`` is not currently supported. ``HOST_IPV6`` can
optionally be used to alter the default IPv6 address optionally be used to alter the default IPv6 address::
::
HOST_IPV6=${some_local_ipv6_address} HOST_IPV6=${some_local_ipv6_address}