From 80d427d9a3c7e6a5e19cfd88d12303ff2463e217 Mon Sep 17 00:00:00 2001
From: "Jay S. Bryant" <jungleboyj@electronicjungle.net>
Date: Sun, 23 Jul 2017 10:20:53 -0500
Subject: [PATCH] [DOC BLD FIX] Fix docstring errors for VMAX driver

There are dosctring errors in the VMAX driver that were causing
the Sphinx build process to generate WARNINGS.  This patch
fixes those errors and improves the generated documentation.

Change-Id: I774bd17a61404b0939b1444dac37ec3f7e0da0b0
---
 .../volume/drivers/dell_emc/vmax/masking.py   |  2 +-
 cinder/volume/drivers/dell_emc/vmax/rest.py   | 10 +++++--
 cinder/volume/drivers/dell_emc/vmax/utils.py  | 29 ++++++++++---------
 3 files changed, 24 insertions(+), 17 deletions(-)

diff --git a/cinder/volume/drivers/dell_emc/vmax/masking.py b/cinder/volume/drivers/dell_emc/vmax/masking.py
index d1417c24a..5d3e9d809 100644
--- a/cinder/volume/drivers/dell_emc/vmax/masking.py
+++ b/cinder/volume/drivers/dell_emc/vmax/masking.py
@@ -1498,7 +1498,7 @@ class VMAXMasking(object):
 
         :param device_info_dict: the data dict
         :param source_storage_group_list: list of storage groups associated
-        with the device
+                                          with the device
         :param extra_specs: extra specifications
         """
         array = device_info_dict['array']
diff --git a/cinder/volume/drivers/dell_emc/vmax/rest.py b/cinder/volume/drivers/dell_emc/vmax/rest.py
index fde417360..2f16014c9 100644
--- a/cinder/volume/drivers/dell_emc/vmax/rest.py
+++ b/cinder/volume/drivers/dell_emc/vmax/rest.py
@@ -1418,9 +1418,13 @@ class VMAXRest(object):
         """Check what replication features are licensed and enabled.
 
         Example return value for this method:
-        {"symmetrixId": "000197800128",
-         "snapVxCapable": true,
-         "rdfCapable": true}
+
+        .. code:: python
+
+          {"symmetrixId": "000197800128",
+           "snapVxCapable": true,
+           "rdfCapable": true}
+
         :param: array
         :returns: capabilities dict for the given array
         """
diff --git a/cinder/volume/drivers/dell_emc/vmax/utils.py b/cinder/volume/drivers/dell_emc/vmax/utils.py
index f6b425ae8..3c6845c10 100644
--- a/cinder/volume/drivers/dell_emc/vmax/utils.py
+++ b/cinder/volume/drivers/dell_emc/vmax/utils.py
@@ -305,19 +305,22 @@ class VMAXUtils(object):
 
         Given a file, parse it to get array and pool(srp).
 
-        <EMC>
-        <RestServerIp>10.108.246.202</RestServerIp>
-        <RestServerPort>8443</RestServerPort>
-        <RestUserName>smc</RestUserName>
-        <RestPassword>smc</RestPassword>
-        <SSLCert>/path/client.cert</SSLCert>
-        <SSLVerify>/path/to/certfile.pem</SSLVerify>
-        <PortGroups>
-            <PortGroup>OS-PORTGROUP1-PG</PortGroup>
-        </PortGroups>
-        <Array>000198700439</Array>
-        <SRP>SRP_1</SRP>
-        </EMC>
+        .. code:: ini
+
+          <EMC>
+          <RestServerIp>10.108.246.202</RestServerIp>
+          <RestServerPort>8443</RestServerPort>
+          <RestUserName>smc</RestUserName>
+          <RestPassword>smc</RestPassword>
+          <SSLCert>/path/client.cert</SSLCert>
+          <SSLVerify>/path/to/certfile.pem</SSLVerify>
+          <PortGroups>
+              <PortGroup>OS-PORTGROUP1-PG</PortGroup>
+          </PortGroups>
+          <Array>000198700439</Array>
+          <SRP>SRP_1</SRP>
+          </EMC>
+
         :param file_name: the configuration file
         :returns: list
         """