Fix some Markdown formatting issues
Address miscellaneous issues with Markdown formatting in comments which
are consumed by shocco when generating the online documentation.
Change-Id: I953075cdbddbf1f119c6c7e35f039e2e54b79078
diff --git a/lib/cinder b/lib/cinder
index f6f137c..ae0e28c 100644
--- a/lib/cinder
+++ b/lib/cinder
@@ -2,19 +2,20 @@
# Install and start **Cinder** volume service
# Dependencies:
+#
# - functions
# - DEST, DATA_DIR, STACK_USER must be defined
-# SERVICE_{TENANT_NAME|PASSWORD} must be defined
-# ``KEYSTONE_TOKEN_FORMAT`` must be defined
+# - SERVICE_{TENANT_NAME|PASSWORD} must be defined
+# - ``KEYSTONE_TOKEN_FORMAT`` must be defined
# stack.sh
# ---------
-# install_cinder
-# configure_cinder
-# init_cinder
-# start_cinder
-# stop_cinder
-# cleanup_cinder
+# - install_cinder
+# - configure_cinder
+# - init_cinder
+# - start_cinder
+# - stop_cinder
+# - cleanup_cinder
# Save trace setting
XTRACE=$(set +o | grep xtrace)
@@ -82,7 +83,8 @@
# Functions
# ---------
# _clean_lvm_lv removes all cinder LVM volumes
-# _clean_lvm_lv $VOLUME_GROUP $VOLUME_NAME_PREFIX
+#
+# Usage: _clean_lvm_lv $VOLUME_GROUP $VOLUME_NAME_PREFIX
function _clean_lvm_lv() {
local vg=$1
local lv_prefix=$2
@@ -98,7 +100,8 @@
# _clean_lvm_backing_file() removes the backing file of the
# volume group used by cinder
-# _clean_lvm_backing_file() $VOLUME_GROUP
+#
+# Usage: _clean_lvm_backing_file() $VOLUME_GROUP
function _clean_lvm_backing_file() {
local vg=$1
@@ -546,6 +549,7 @@
# Restore xtrace
$XTRACE
-# Local variables:
-# mode: shell-script
-# End:
+# Tell emacs to use shell-script-mode
+## Local variables:
+## mode: shell-script
+## End: