Fix shocco errors during docs generation
Closes-Bug: 1362691
Change-Id: I2b7fb008c89f0b4e7280b2d0a054320765e83e47
... | ... |
@@ -71,10 +71,10 @@ function upload_image { |
71 | 71 |
fi |
72 | 72 |
image="$FILES/${image_fname}" |
73 | 73 |
else |
74 |
- # File based URL (RFC 1738): file://host/path |
|
74 |
+ # File based URL (RFC 1738): ``file://host/path`` |
|
75 | 75 |
# Remote files are not considered here. |
76 |
- # *nix: file:///home/user/path/file |
|
77 |
- # windows: file:///C:/Documents%20and%20Settings/user/path/file |
|
76 |
+ # unix: ``file:///home/user/path/file`` |
|
77 |
+ # windows: ``file:///C:/Documents%20and%20Settings/user/path/file`` |
|
78 | 78 |
image=$(echo $image_url | sed "s/^file:\/\///g") |
79 | 79 |
if [[ ! -f $image || "$(stat -c "%s" $image)" == "0" ]]; then |
80 | 80 |
echo "Not found: $image_url" |
... | ... |
@@ -123,7 +123,7 @@ function upload_image { |
123 | 123 |
if [[ "$vmdk_create_type" = "monolithicSparse" ]]; then |
124 | 124 |
vmdk_disktype="sparse" |
125 | 125 |
elif [[ "$vmdk_create_type" = "monolithicFlat" || "$vmdk_create_type" = "vmfs" ]]; then |
126 |
- # Attempt to retrieve the *-flat.vmdk |
|
126 |
+ # Attempt to retrieve the ``*-flat.vmdk`` |
|
127 | 127 |
local flat_fname="$(head -25 $image | { grep -G 'RW\|RDONLY [0-9]+ FLAT\|VMFS' $image || true; })" |
128 | 128 |
flat_fname="${flat_fname#*\"}" |
129 | 129 |
flat_fname="${flat_fname%?}" |
... | ... |
@@ -31,6 +31,7 @@ |
31 | 31 |
# - ``TRACK_DEPENDS`` |
32 | 32 |
# - ``UNDO_REQUIREMENTS`` |
33 | 33 |
# - ``http_proxy``, ``https_proxy``, ``no_proxy`` |
34 |
+# |
|
34 | 35 |
|
35 | 36 |
# Save trace setting |
36 | 37 |
XTRACE=$(set +o | grep xtrace) |
... | ... |
@@ -1253,7 +1254,8 @@ function screen_service { |
1253 | 1253 |
# - the pid of the background process is saved in the usual place |
1254 | 1254 |
# - the server process is brought back to the foreground |
1255 | 1255 |
# - if the server process exits prematurely the fg command errors |
1256 |
- # and a message is written to stdout and the service failure file |
|
1256 |
+ # and a message is written to stdout and the service failure file |
|
1257 |
+ # |
|
1257 | 1258 |
# The pid saved can be used in stop_process() as a process group |
1258 | 1259 |
# id to kill off all child processes |
1259 | 1260 |
if [[ -n "$group" ]]; then |
... | ... |
@@ -16,6 +16,7 @@ |
16 | 16 |
# |
17 | 17 |
# Authors: |
18 | 18 |
# Alon Marx <alonma@il.ibm.com> |
19 |
+# |
|
19 | 20 |
|
20 | 21 |
# lib/cinder_plugins/xiv |
21 | 22 |
# Configure the xiv_ds8k driver for xiv testing |
... | ... |
@@ -61,7 +62,7 @@ function configure_cinder_backend_xiv { |
61 | 61 |
fi |
62 | 62 |
|
63 | 63 |
# For reference: |
64 |
- # XIV_DS8K_BACKEND='IBM-XIV_'${SAN_IP}'_'${SAN_CLUSTERNAME}'_'${CONNECTION_TYPE} |
|
64 |
+ # ``XIV_DS8K_BACKEND='IBM-XIV_'${SAN_IP}'_'${SAN_CLUSTERNAME}'_'${CONNECTION_TYPE}`` |
|
65 | 65 |
iniset $CINDER_CONF DEFAULT xiv_ds8k_driver_version $XIV_DRIVER_VERSION |
66 | 66 |
|
67 | 67 |
iniset $CINDER_CONF $be_name san_ip $SAN_IP |
... | ... |
@@ -177,9 +177,10 @@ fi |
177 | 177 |
|
178 | 178 |
# Distributed Virtual Router (DVR) configuration |
179 | 179 |
# Can be: |
180 |
-# legacy - No DVR functionality |
|
181 |
-# dvr_snat - Controller or single node DVR |
|
182 |
-# dvr - Compute node in multi-node DVR |
|
180 |
+# - ``legacy`` - No DVR functionality |
|
181 |
+# - ``dvr_snat`` - Controller or single node DVR |
|
182 |
+# - ``dvr`` - Compute node in multi-node DVR |
|
183 |
+# |
|
183 | 184 |
Q_DVR_MODE=${Q_DVR_MODE:-legacy} |
184 | 185 |
if [[ "$Q_DVR_MODE" != "legacy" ]]; then |
185 | 186 |
Q_ML2_PLUGIN_MECHANISM_DRIVERS=openvswitch,linuxbridge,l2population |
... | ... |
@@ -677,7 +677,7 @@ function start_nova_compute { |
677 | 677 |
|
678 | 678 |
if [[ "$VIRT_DRIVER" = 'libvirt' ]]; then |
679 | 679 |
# The group **$LIBVIRT_GROUP** is added to the current user in this script. |
680 |
- # sg' will be used in run_process to execute nova-compute as a member of the |
|
680 |
+ # ``sg`` is used in run_process to execute nova-compute as a member of the |
|
681 | 681 |
# **$LIBVIRT_GROUP** group. |
682 | 682 |
run_process n-cpu "$NOVA_BIN_DIR/nova-compute --config-file $compute_cell_conf" $LIBVIRT_GROUP |
683 | 683 |
elif [[ "$VIRT_DRIVER" = 'fake' ]]; then |
... | ... |
@@ -3,9 +3,9 @@ |
3 | 3 |
|
4 | 4 |
# Dependencies: |
5 | 5 |
# |
6 |
-# - ``functions`` file |
|
7 |
-# # ``DEST`` must be defined |
|
8 |
-# # ``STACK_USER`` must be defined |
|
6 |
+# ``functions`` file |
|
7 |
+# ``DEST`` must be defined |
|
8 |
+# ``STACK_USER`` must be defined |
|
9 | 9 |
|
10 | 10 |
# ``stack.sh`` calls the entry points in this order: |
11 | 11 |
# |
... | ... |
@@ -55,7 +55,7 @@ ODL_URL=${ODL_URL:-https://nexus.opendaylight.org/content/repositories/opendayli |
55 | 55 |
|
56 | 56 |
# Default arguments for OpenDaylight. This is typically used to set |
57 | 57 |
# Java memory options. |
58 |
-# ODL_ARGS=Xmx1024m -XX:MaxPermSize=512m |
|
58 |
+# ``ODL_ARGS=Xmx1024m -XX:MaxPermSize=512m`` |
|
59 | 59 |
ODL_ARGS=${ODL_ARGS:-"-XX:MaxPermSize=384m"} |
60 | 60 |
|
61 | 61 |
# How long to pause after ODL starts to let it complete booting |
... | ... |
@@ -64,8 +64,6 @@ ODL_BOOT_WAIT=${ODL_BOOT_WAIT:-60} |
64 | 64 |
# The physical provider network to device mapping |
65 | 65 |
ODL_PROVIDER_MAPPINGS=${ODL_PROVIDER_MAPPINGS:-physnet1:eth1} |
66 | 66 |
|
67 |
-# Set up default directories |
|
68 |
- |
|
69 | 67 |
|
70 | 68 |
# Entry Points |
71 | 69 |
# ------------ |
... | ... |
@@ -139,6 +137,7 @@ function start_opendaylight { |
139 | 139 |
# The flags to ODL have the following meaning: |
140 | 140 |
# -of13: runs ODL using OpenFlow 1.3 protocol support. |
141 | 141 |
# -virt ovsdb: Runs ODL in "virtualization" mode with OVSDB support |
142 |
+ |
|
142 | 143 |
# NOTE(chdent): Leaving this as screen_it instead of run_process until |
143 | 144 |
# the right thing for this service is determined. |
144 | 145 |
screen_it odl-server "cd $ODL_DIR/opendaylight && JAVA_HOME=$JHOME ./run.sh $ODL_ARGS -of13 -virt ovsdb" |
... | ... |
@@ -117,7 +117,7 @@ GIT_TIMEOUT=${GIT_TIMEOUT:-0} |
117 | 117 |
# ------------ |
118 | 118 |
|
119 | 119 |
# Base GIT Repo URL |
120 |
-# Another option is http://review.openstack.org/p |
|
120 |
+# Another option is https://git.openstack.org |
|
121 | 121 |
GIT_BASE=${GIT_BASE:-git://git.openstack.org} |
122 | 122 |
|
123 | 123 |
# metering service |
... | ... |
@@ -238,7 +238,7 @@ function get_user_id { |
238 | 238 |
} |
239 | 239 |
|
240 | 240 |
if [ $MODE != "create" ]; then |
241 |
-# looks like I can't ask for all tenant related to a specified user |
|
241 |
+ # looks like I can't ask for all tenant related to a specified user |
|
242 | 242 |
openstack project list --long --quote none -f csv | grep ',True' | grep -v "${SKIP_TENANT}" | while IFS=, read tenant_id tenant_name desc enabled; do |
243 | 243 |
openstack user list --project $tenant_id --long --quote none -f csv | grep ',True' | while IFS=, read user_id user_name project email enabled; do |
244 | 244 |
if [ $MODE = one -a "$user_name" != "$USER_NAME" ]; then |
... | ... |
@@ -246,8 +246,7 @@ if [ $MODE != "create" ]; then |
246 | 246 |
fi |
247 | 247 |
|
248 | 248 |
# Checks for a specific password defined for an user. |
249 |
- # Example for an username johndoe: |
|
250 |
- # JOHNDOE_PASSWORD=1234 |
|
249 |
+ # Example for an username johndoe: JOHNDOE_PASSWORD=1234 |
|
251 | 250 |
eval SPECIFIC_UPASSWORD="\$${USER_NAME^^}_PASSWORD" |
252 | 251 |
if [ -n "$SPECIFIC_UPASSWORD" ]; then |
253 | 252 |
USER_PASS=$SPECIFIC_UPASSWORD |