From: Tom Fifield <tom@openstack.org>
Date: Tue, 24 Jun 2014 13:59:20 +0000 (+0800)
Subject: Enhance docstring for iscsi_helper
X-Git-Url: https://review.fuel-infra.org/gitweb?a=commitdiff_plain;h=5a93b26f7d595157804736fd83f9b1ba80394880;p=openstack-build%2Fcinder-build.git

Enhance docstring for iscsi_helper

The helptext for the iscsi_helper option did not mention the
potential to use lioadm (or fake). This patch simply amends
the text so this functionality is more discoverable.

Change-Id: I4bf4a6f77191a7f42d5b38f71759944e4997ccc6
---

diff --git a/cinder/volume/driver.py b/cinder/volume/driver.py
index d55f7d64f..a8c12c36e 100644
--- a/cinder/volume/driver.py
+++ b/cinder/volume/driver.py
@@ -80,7 +80,9 @@ volume_opts = [
                     'for example "-c3" for idle only priority.'),
     cfg.StrOpt('iscsi_helper',
                default='tgtadm',
-               help='iSCSI target user-land tool to use'),
+               help='iSCSI target user-land tool to use. tgtadm is default, '
+                    'use lioadm for LIO iSCSI support, iseradm for the ISER '
+                    'protocol, or fake for testing.'),
     cfg.StrOpt('volumes_dir',
                default='$state_path/volumes',
                help='Volume configuration file storage '
diff --git a/etc/cinder/cinder.conf.sample b/etc/cinder/cinder.conf.sample
index 363de3d72..fa6664af2 100644
--- a/etc/cinder/cinder.conf.sample
+++ b/etc/cinder/cinder.conf.sample
@@ -997,7 +997,9 @@
 # "-c3" for idle only priority. (string value)
 #volume_clear_ionice=<None>
 
-# iSCSI target user-land tool to use (string value)
+# iSCSI target user-land tool to use. tgtadm is default, use
+# lioadm for LIO iSCSI support, iseradm for the ISER protocol,
+# or fake for testing. (string value)
 #iscsi_helper=tgtadm
 
 # Volume configuration file storage directory (string value)