openstack/devstack
Code Issues Proposed changes

Fix docs build errors

Browse Source 
Fix shocco errors during docs generation

Closes-Bug: 1362691
Change-Id: I2b7fb008c89f0b4e7280b2d0a054320765e83e47
This commit is contained in:
Dean Troyer 2014-09-18 09:26:39 -05:00
parent 7672ad1dbc
commit 3324f19f5a
11 changed files with 26 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
functions
View File

@ -71,10 +71,10 @@ function upload_image {
fi fi
image="$FILES/${image_fname}" image="$FILES/${image_fname}"
else else
# File based URL (RFC 1738): file://host/path # File based URL (RFC 1738): ``file://host/path``
# Remote files are not considered here. # Remote files are not considered here.
# *nix: file:///home/user/path/file # unix: ``file:///home/user/path/file``
# windows: file:///C:/Documents%20and%20Settings/user/path/file # windows: ``file:///C:/Documents%20and%20Settings/user/path/file``
image=$(echo $image_url | sed "s/^file:\/\///g") image=$(echo $image_url | sed "s/^file:\/\///g")
if [[ ! -f $image || "$(stat -c "%s" $image)" == "0" ]]; then if [[ ! -f $image || "$(stat -c "%s" $image)" == "0" ]]; then
echo "Not found: $image_url" echo "Not found: $image_url"
@ -123,7 +123,7 @@ function upload_image {
if [[ "$vmdk_create_type" = "monolithicSparse" ]]; then if [[ "$vmdk_create_type" = "monolithicSparse" ]]; then
vmdk_disktype="sparse" vmdk_disktype="sparse"
elif [[ "$vmdk_create_type" = "monolithicFlat" || "$vmdk_create_type" = "vmfs" ]]; then elif [[ "$vmdk_create_type" = "monolithicFlat" || "$vmdk_create_type" = "vmfs" ]]; then
# Attempt to retrieve the *-flat.vmdk # Attempt to retrieve the ``*-flat.vmdk``
local flat_fname="$(head -25 $image | { grep -G 'RW\|RDONLY [0-9]+ FLAT\|VMFS' $image || true; })" local flat_fname="$(head -25 $image | { grep -G 'RW\|RDONLY [0-9]+ FLAT\|VMFS' $image || true; })"
flat_fname="${flat_fname#*\"}" flat_fname="${flat_fname#*\"}"
flat_fname="${flat_fname%?}" flat_fname="${flat_fname%?}"

2
functions-common
View File

@ -31,6 +31,7 @@
# - ``TRACK_DEPENDS`` # - ``TRACK_DEPENDS``
# - ``UNDO_REQUIREMENTS`` # - ``UNDO_REQUIREMENTS``
# - ``http_proxy``, ``https_proxy``, ``no_proxy`` # - ``http_proxy``, ``https_proxy``, ``no_proxy``
#
# Save trace setting # Save trace setting
XTRACE=$(set +o | grep xtrace) XTRACE=$(set +o | grep xtrace)
@ -1254,6 +1255,7 @@ function screen_service {
# - the server process is brought back to the foreground # - the server process is brought back to the foreground
# - if the server process exits prematurely the fg command errors # - if the server process exits prematurely the fg command errors
# and a message is written to stdout and the service failure file # and a message is written to stdout and the service failure file
#
# The pid saved can be used in stop_process() as a process group # The pid saved can be used in stop_process() as a process group
# id to kill off all child processes # id to kill off all child processes
if [[ -n "$group" ]]; then if [[ -n "$group" ]]; then

3
lib/cinder_backends/xiv
View File

@ -16,6 +16,7 @@
# #
# Authors: # Authors:
# Alon Marx <alonma@il.ibm.com> # Alon Marx <alonma@il.ibm.com>
#
# lib/cinder_plugins/xiv # lib/cinder_plugins/xiv
# Configure the xiv_ds8k driver for xiv testing # Configure the xiv_ds8k driver for xiv testing
@ -61,7 +62,7 @@ function configure_cinder_backend_xiv {
fi fi
# For reference: # For reference:
# XIV_DS8K_BACKEND='IBM-XIV_'${SAN_IP}'_'${SAN_CLUSTERNAME}'_'${CONNECTION_TYPE} # ``XIV_DS8K_BACKEND='IBM-XIV_'${SAN_IP}'_'${SAN_CLUSTERNAME}'_'${CONNECTION_TYPE}``
iniset $CINDER_CONF DEFAULT xiv_ds8k_driver_version $XIV_DRIVER_VERSION iniset $CINDER_CONF DEFAULT xiv_ds8k_driver_version $XIV_DRIVER_VERSION
iniset $CINDER_CONF $be_name san_ip $SAN_IP iniset $CINDER_CONF $be_name san_ip $SAN_IP

7
lib/neutron
View File

@ -177,9 +177,10 @@ fi
# Distributed Virtual Router (DVR) configuration # Distributed Virtual Router (DVR) configuration
# Can be: # Can be:
# legacy - No DVR functionality # - ``legacy`` - No DVR functionality
# dvr_snat - Controller or single node DVR # - ``dvr_snat`` - Controller or single node DVR
# dvr - Compute node in multi-node DVR # - ``dvr`` - Compute node in multi-node DVR
#
Q_DVR_MODE=${Q_DVR_MODE:-legacy} Q_DVR_MODE=${Q_DVR_MODE:-legacy}
if [[ "$Q_DVR_MODE" != "legacy" ]]; then if [[ "$Q_DVR_MODE" != "legacy" ]]; then
Q_ML2_PLUGIN_MECHANISM_DRIVERS=openvswitch,linuxbridge,l2population Q_ML2_PLUGIN_MECHANISM_DRIVERS=openvswitch,linuxbridge,l2population

3
lib/neutron_plugins/oneconvergence
View File

@ -1,5 +1,6 @@
# Neutron One Convergence plugin # Neutron One Convergence plugin
# --------------------------- # ------------------------------
# Save trace setting # Save trace setting
OC_XTRACE=$(set +o | grep xtrace) OC_XTRACE=$(set +o | grep xtrace)
set +o xtrace set +o xtrace

2
lib/nova
View File

@ -677,7 +677,7 @@ function start_nova_compute {
if [[ "$VIRT_DRIVER" = 'libvirt' ]]; then if [[ "$VIRT_DRIVER" = 'libvirt' ]]; then
# The group **$LIBVIRT_GROUP** is added to the current user in this script. # The group **$LIBVIRT_GROUP** is added to the current user in this script.
# sg' will be used in run_process to execute nova-compute as a member of the # ``sg`` is used in run_process to execute nova-compute as a member of the
# **$LIBVIRT_GROUP** group. # **$LIBVIRT_GROUP** group.
run_process n-cpu "$NOVA_BIN_DIR/nova-compute --config-file $compute_cell_conf" $LIBVIRT_GROUP run_process n-cpu "$NOVA_BIN_DIR/nova-compute --config-file $compute_cell_conf" $LIBVIRT_GROUP
elif [[ "$VIRT_DRIVER" = 'fake' ]]; then elif [[ "$VIRT_DRIVER" = 'fake' ]]; then

2
lib/nova_plugins/functions-libvirt
View File

@ -10,7 +10,7 @@ LV_XTRACE=$(set +o | grep xtrace)
set +o xtrace set +o xtrace
# Defaults # Defaults
# ------- # --------
# if we should turn on massive libvirt debugging # if we should turn on massive libvirt debugging
DEBUG_LIBVIRT=$(trueorfalse False $DEBUG_LIBVIRT) DEBUG_LIBVIRT=$(trueorfalse False $DEBUG_LIBVIRT)

11
lib/opendaylight
View File

@ -3,9 +3,9 @@
# Dependencies: # Dependencies:
# #
# - ``functions`` file # ``functions`` file
# # ``DEST`` must be defined # ``DEST`` must be defined
# # ``STACK_USER`` must be defined # ``STACK_USER`` must be defined
# ``stack.sh`` calls the entry points in this order: # ``stack.sh`` calls the entry points in this order:
# #
@ -55,7 +55,7 @@ ODL_URL=${ODL_URL:-https://nexus.opendaylight.org/content/repositories/opendayli
# Default arguments for OpenDaylight. This is typically used to set # Default arguments for OpenDaylight. This is typically used to set
# Java memory options. # Java memory options.
# ODL_ARGS=Xmx1024m -XX:MaxPermSize=512m # ``ODL_ARGS=Xmx1024m -XX:MaxPermSize=512m``
ODL_ARGS=${ODL_ARGS:-"-XX:MaxPermSize=384m"} ODL_ARGS=${ODL_ARGS:-"-XX:MaxPermSize=384m"}
# How long to pause after ODL starts to let it complete booting # How long to pause after ODL starts to let it complete booting
@ -64,8 +64,6 @@ ODL_BOOT_WAIT=${ODL_BOOT_WAIT:-60}
# The physical provider network to device mapping # The physical provider network to device mapping
ODL_PROVIDER_MAPPINGS=${ODL_PROVIDER_MAPPINGS:-physnet1:eth1} ODL_PROVIDER_MAPPINGS=${ODL_PROVIDER_MAPPINGS:-physnet1:eth1}
# Set up default directories
# Entry Points # Entry Points
# ------------ # ------------
@ -139,6 +137,7 @@ function start_opendaylight {
# The flags to ODL have the following meaning: # The flags to ODL have the following meaning:
# -of13: runs ODL using OpenFlow 1.3 protocol support. # -of13: runs ODL using OpenFlow 1.3 protocol support.
# -virt ovsdb: Runs ODL in "virtualization" mode with OVSDB support # -virt ovsdb: Runs ODL in "virtualization" mode with OVSDB support
# NOTE(chdent): Leaving this as screen_it instead of run_process until # NOTE(chdent): Leaving this as screen_it instead of run_process until
# the right thing for this service is determined. # the right thing for this service is determined.
screen_it odl-server "cd $ODL_DIR/opendaylight && JAVA_HOME=$JHOME ./run.sh $ODL_ARGS -of13 -virt ovsdb" screen_it odl-server "cd $ODL_DIR/opendaylight && JAVA_HOME=$JHOME ./run.sh $ODL_ARGS -of13 -virt ovsdb"

2
lib/tls
View File

@ -383,7 +383,7 @@ function start_tls_proxy {
# Cleanup Functions # Cleanup Functions
# =============== # =================
# Stops all stud processes. This should be done only after all services # Stops all stud processes. This should be done only after all services

2
stackrc
View File

@ -117,7 +117,7 @@ GIT_TIMEOUT=${GIT_TIMEOUT:-0}
# ------------ # ------------
# Base GIT Repo URL # Base GIT Repo URL
# Another option is http://review.openstack.org/p # Another option is https://git.openstack.org
GIT_BASE=${GIT_BASE:-git://git.openstack.org} GIT_BASE=${GIT_BASE:-git://git.openstack.org}
# metering service # metering service

3
tools/create_userrc.sh
View File

@ -246,8 +246,7 @@ if [ $MODE != "create" ]; then
fi fi
# Checks for a specific password defined for an user. # Checks for a specific password defined for an user.
# Example for an username johndoe: # Example for an username johndoe: JOHNDOE_PASSWORD=1234
# JOHNDOE_PASSWORD=1234
eval SPECIFIC_UPASSWORD="\$${USER_NAME^^}_PASSWORD" eval SPECIFIC_UPASSWORD="\$${USER_NAME^^}_PASSWORD"
if [ -n "$SPECIFIC_UPASSWORD" ]; then if [ -n "$SPECIFIC_UPASSWORD" ]; then
USER_PASS=$SPECIFIC_UPASSWORD USER_PASS=$SPECIFIC_UPASSWORD