[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
This commit is contained in:
Jay S. Bryant 2017-07-24 11:39:59 -05:00
parent 212b045a02
commit ae262dbed3
2 changed files with 37 additions and 23 deletions
cinder/volume/drivers/falconstor

@ -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=<thin-volume-size> volume-size
.. code:: console
create --volume-type FSS-THIN
--metadata thinsize=<thin-volume-size> volume-size
Create a LUN that is a Timeview of another LUN at a specified CDP tag:
[Usage] create --volume-type FSS --metadata timeview=<vid>
cdptag=<tag> volume-size
.. code:: console
create --volume-type FSS --metadata timeview=<vid>
cdptag=<tag> volume-size
Create a LUN that is a Timeview of another LUN at a specified Timemark:
[Usage] create --volume-type FSS --metadata timeview=<vid>
rawtimestamp=<rawtimestamp> volume-size
.. code:: console
create --volume-type FSS --metadata timeview=<vid>
rawtimestamp=<rawtimestamp> volume-size
Create a mirrored volume :
[Usage] create --volume-type FSS --metadata mirrored=true
.. code:: console
create --volume-type FSS --metadata mirrored=true
"""

@ -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
"""