Fix shocco errors and warnings
A few Markdown-oriented issues were causing Docutils errors to
leak into the end-user docs on http://devstack.org
Change-Id: I51fa9698afb1bfb48596478d83bd1fdcd84ac52e
diff --git a/lib/baremetal b/lib/baremetal
index 141c28d..5606230 100644
--- a/lib/baremetal
+++ b/lib/baremetal
@@ -83,8 +83,10 @@
# To provide PXE, configure nova-network's dnsmasq rather than run the one
# dedicated to baremetal. When enable this, make sure these conditions are
# fulfilled:
+#
# 1) nova-compute and nova-network runs on the same host
# 2) nova-network uses FlatDHCPManager
+#
# NOTE: the other BM_DNSMASQ_* have no effect on the behavior if this option
# is enabled.
BM_DNSMASQ_FROM_NOVA_NETWORK=`trueorfalse False $BM_DNSMASQ_FROM_NOVA_NETWORK`
@@ -198,8 +200,8 @@
BM_FIRST_MAC=$(sudo $bm_poseur get-macs)
# NOTE: there is currently a limitation in baremetal driver
- # that requires second MAC even if it is not used.
- # Passing a fake value allows this to work.
+ # that requires second MAC even if it is not used.
+ # Passing a fake value allows this to work.
# TODO(deva): remove this after driver issue is fixed.
BM_SECOND_MAC='12:34:56:78:90:12'
}
diff --git a/lib/ceilometer b/lib/ceilometer
index cd4c4d8..a471d9c 100644
--- a/lib/ceilometer
+++ b/lib/ceilometer
@@ -2,9 +2,11 @@
# Install and start **Ceilometer** service
# To enable a minimal set of Ceilometer services, add the following to localrc:
+#
# enable_service ceilometer-acompute ceilometer-acentral ceilometer-collector ceilometer-api
#
# To ensure Ceilometer alarming services are enabled also, further add to the localrc:
+#
# enable_service ceilometer-alarm-notifier ceilometer-alarm-evaluator
# Dependencies:
diff --git a/lib/database b/lib/database
index 3c15609..c3fd435 100644
--- a/lib/database
+++ b/lib/database
@@ -9,10 +9,11 @@
# This is a wrapper for the specific database backends available.
# Each database must implement four functions:
-# recreate_database_$DATABASE_TYPE
-# install_database_$DATABASE_TYPE
-# configure_database_$DATABASE_TYPE
-# database_connection_url_$DATABASE_TYPE
+#
+# - recreate_database_$DATABASE_TYPE
+# - install_database_$DATABASE_TYPE
+# - configure_database_$DATABASE_TYPE
+# - database_connection_url_$DATABASE_TYPE
#
# and call register_database $DATABASE_TYPE
@@ -22,7 +23,9 @@
# Register a database backend
-# $1 The name of the database backend
+#
+# $1 The name of the database backend
+#
# This is required to be defined before the specific database scripts are sourced
function register_database {
[ -z "$DATABASE_BACKENDS" ] && DATABASE_BACKENDS=$1 || DATABASE_BACKENDS+=" $1"
diff --git a/lib/neutron b/lib/neutron
index 44fb9e1..00852df 100644
--- a/lib/neutron
+++ b/lib/neutron
@@ -208,7 +208,7 @@
source $TOP_DIR/lib/neutron_plugins/services/vpn
# Firewall Service Plugin functions
-# --------------------------------
+# ---------------------------------
source $TOP_DIR/lib/neutron_plugins/services/firewall
# Use security group or not
@@ -494,6 +494,7 @@
# For main plugin config file, set ``Q_PLUGIN_CONF_PATH``, ``Q_PLUGIN_CONF_FILENAME``.
# For addition plugin config files, set ``Q_PLUGIN_EXTRA_CONF_PATH``,
# ``Q_PLUGIN_EXTRA_CONF_FILES``. For example:
+ #
# ``Q_PLUGIN_EXTRA_CONF_FILES=(file1, file2)``
neutron_plugin_configure_common
diff --git a/lib/swift b/lib/swift
index 8726f1e..3c3b8b1 100644
--- a/lib/swift
+++ b/lib/swift
@@ -268,8 +268,8 @@
# By default Swift will be installed with keystone and tempauth middleware
# and add the swift3 middleware if its configured for it. The token for
- # tempauth would be prefixed with the reseller_prefix setting TEMPAUTH_ the
- # token for keystoneauth would have the standard reseller_prefix AUTH_
+ # tempauth would be prefixed with the reseller_prefix setting `TEMPAUTH_` the
+ # token for keystoneauth would have the standard reseller_prefix `AUTH_`
if is_service_enabled swift3;then
swift_pipeline=" swift3 s3token "
fi