From ae262dbed31620950893b6506913ebacea9327a8 Mon Sep 17 00:00:00 2001 From: "Jay S. Bryant" Date: Mon, 24 Jul 2017 11:39:59 -0500 Subject: [PATCH] [DOC BLD FIX] Correct docstring errors in falconstor driver There were a couple of formatting issues in dosctrings causing the Sphinx to produce WARNINGs when processesing the falconstor driver. This patch corrects them. Change-Id: Ie66da44e7e26a25c500ff752ad9b9a7b7b7eefbf --- .../volume/drivers/falconstor/fss_common.py | 26 ++++++++++---- cinder/volume/drivers/falconstor/iscsi.py | 34 ++++++++++--------- 2 files changed, 37 insertions(+), 23 deletions(-) diff --git a/cinder/volume/drivers/falconstor/fss_common.py b/cinder/volume/drivers/falconstor/fss_common.py index c74a96ae2..f2503328d 100644 --- a/cinder/volume/drivers/falconstor/fss_common.py +++ b/cinder/volume/drivers/falconstor/fss_common.py @@ -178,19 +178,31 @@ class FalconstorBaseDriver(san.SanDriver): We use the metadata of the volume to create variety volume. Create a thin provisioned volume : - [Usage] create --volume-type FSS-THIN - --metadata thinsize= volume-size + + .. code:: console + + create --volume-type FSS-THIN + --metadata thinsize= volume-size Create a LUN that is a Timeview of another LUN at a specified CDP tag: - [Usage] create --volume-type FSS --metadata timeview= - cdptag= volume-size + + .. code:: console + + create --volume-type FSS --metadata timeview= + cdptag= volume-size Create a LUN that is a Timeview of another LUN at a specified Timemark: - [Usage] create --volume-type FSS --metadata timeview= - rawtimestamp= volume-size + + .. code:: console + + create --volume-type FSS --metadata timeview= + rawtimestamp= volume-size Create a mirrored volume : - [Usage] create --volume-type FSS --metadata mirrored=true + + .. code:: console + + create --volume-type FSS --metadata mirrored=true """ diff --git a/cinder/volume/drivers/falconstor/iscsi.py b/cinder/volume/drivers/falconstor/iscsi.py index d50c7968f..633931305 100644 --- a/cinder/volume/drivers/falconstor/iscsi.py +++ b/cinder/volume/drivers/falconstor/iscsi.py @@ -33,22 +33,24 @@ class FSSISCSIDriver(fss_common.FalconstorBaseDriver, To enable the driver add the following line to the cinder configuration: volume_driver=cinder.volume.drivers.falconstor.iscsi.FSSISCSIDriver - Version history: - 1.0.0 - Initial driver - 1.0.1 - Fix copy_image_to_volume error. - 1.0.2 - Closes-Bug #1554184, add lun id type conversion in - initialize_connection - 1.03 - merge source code - 1.04 - Fixed create_volume_from_snapshot(), create_cloned_volume() - metadata TypeError - 2.0.0 - Newton driver - -- fixed consisgroup commands error - 2.0.1 -- fixed bugs - 2.0.2 -- support Multipath - 3.0.0 - Ocata driver - -- fixed bugs - 4.0.0 - Pike driver - -- extend Cinder driver to utilize multiple FSS storage pools + .. code: text + + Version history: + 1.0.0 - Initial driver + 1.0.1 - Fix copy_image_to_volume error. + 1.0.2 - Closes-Bug #1554184, add lun id type conversion in + initialize_connection + 1.03 - merge source code + 1.04 - Fixed create_volume_from_snapshot(), create_cloned_volume() + metadata TypeError + 2.0.0 - Newton driver + -- fixed consisgroup commands error + 2.0.1 -- fixed bugs + 2.0.2 -- support Multipath + 3.0.0 - Ocata driver + -- fixed bugs + 4.0.0 - Pike driver + -- extend Cinder driver to utilize multiple FSS storage pools """