[DOC BLD FIX] Fix docstring issues in dothill driver

As with other drivers the version history at the top of the
dothill driver was causing Sphinx build WARNINGs to be issued.
This changes puts the version history in a text box for better
readability and to avoid the WARNING.

Change-Id: I387ae425e3a2a1e37264589bb33a0acdcf61ca9a
This commit is contained in:
Jay S. Bryant 2017-07-24 11:23:41 -05:00
parent 212b045a02
commit 48ff447f6a
2 changed files with 36 additions and 30 deletions

View File

@ -30,20 +30,23 @@ from cinder.zonemanager import utils as fczm_utils
class DotHillFCDriver(cinder.volume.driver.FibreChannelDriver):
"""OpenStack Fibre Channel cinder drivers for DotHill Arrays.
Version history:
0.1 - Base version developed for HPMSA FC drivers:
"https://github.com/openstack/cinder/tree/stable/juno/
cinder/volume/drivers/san/hp"
1.0 - Version developed for DotHill arrays with the following
modifications:
- added support for v3 API(virtual pool feature)
- added support for retype volume
- added support for manage/unmanage volume
- added initiator target mapping in FC zoning
- added https support
1.6 - Add management path redundancy and reduce load placed
on management controller.
1.7 - Modified so it can't be invoked except as a superclass
.. code:: text
Version history:
0.1 - Base version developed for HPMSA FC drivers:
"https://github.com/openstack/cinder/tree/stable/juno/
cinder/volume/drivers/san/hp"
1.0 - Version developed for DotHill arrays with the following
modifications:
- added support for v3 API(virtual pool feature)
- added support for retype volume
- added support for manage/unmanage volume
- added initiator target mapping in FC zoning
- added https support
1.6 - Add management path redundancy and reduce load placed
on management controller.
1.7 - Modified so it can't be invoked except as a superclass
"""
def __init__(self, *args, **kwargs):

View File

@ -36,22 +36,25 @@ LOG = logging.getLogger(__name__)
class DotHillISCSIDriver(cinder.volume.driver.ISCSIDriver):
"""OpenStack iSCSI cinder drivers for DotHill Arrays.
Version history:
0.1 - Base structure for DotHill iSCSI drivers based on HPMSA FC
drivers:
"https://github.com/openstack/cinder/tree/stable/juno/
cinder/volume/drivers/san/hp"
1.0 - Version developed for DotHill arrays with the following
modifications:
- added iSCSI support
- added CHAP support in iSCSI
- added support for v3 API(virtual pool feature)
- added support for retype volume
- added support for manage/unmanage volume
- added https support
1.6 - Add management path redundancy and reduce load placed
on management controller.
1.7 - Modified so it can't be invoked except as a superclass
.. code:: text
Version history:
0.1 - Base structure for DotHill iSCSI drivers based on HPMSA FC
drivers:
"https://github.com/openstack/cinder/tree/stable/juno/
cinder/volume/drivers/san/hp"
1.0 - Version developed for DotHill arrays with the following
modifications:
- added iSCSI support
- added CHAP support in iSCSI
- added support for v3 API(virtual pool feature)
- added support for retype volume
- added support for manage/unmanage volume
- added https support
1.6 - Add management path redundancy and reduce load placed
on management controller.
1.7 - Modified so it can't be invoked except as a superclass
"""
def __init__(self, *args, **kwargs):