From 9b15e56359f8c1ab4a158ffbf0ee3d1ff5b661af Mon Sep 17 00:00:00 2001
From: Sivasathurappan Radhakrishnan <siva.radhakrishnan@intel.com>
Date: Wed, 18 May 2016 00:35:45 +0000
Subject: [PATCH] Improve the help text for the guestfs options

The previous commit moved guestfs options to a central
location. This commit adds additional help text to those options.

Also, improved help text based on [1] and removed the tags.

  [1] https://wiki.openstack.org/wiki/ConfigOptionsConsistency

Blueprint centralize-config-options-newton

Change-Id: I23aa13aeeee919131510a4af2a54d5c1b68c63b8
---
 nova/conf/guestfs.py | 52 ++++++++++++++++++++++++++------------------
 1 file changed, 31 insertions(+), 21 deletions(-)

diff --git a/nova/conf/guestfs.py b/nova/conf/guestfs.py
index 9bc274a8c43f..11b16f94fe95 100644
--- a/nova/conf/guestfs.py
+++ b/nova/conf/guestfs.py
@@ -1,9 +1,3 @@
-# needs:check_deprecation_status
-# needs:check_opt_group_and_type
-# needs:fix_opt_description_indentation
-# needs:fix_opt_registration_consistency
-
-
 # Copyright 2015 OpenStack Foundation
 # All Rights Reserved.
 #
@@ -21,26 +15,42 @@
 
 from oslo_config import cfg
 
-enable_guestfs_debug_opts = cfg.BoolOpt('debug',
-                                        default=False,
-                                        help="""
-Enable the debug mode of "libguestfs".
-
-If this node uses "libguestfs" (for example to inject data or passwords),
-this option can be used to turn its debug mode on.
-
-Possible values:
-* True: turn debug on. This integrates libguestfs's logs into the log
-  of OpenStack.
-* False: turn debug off
+guestfs_group = cfg.OptGroup('guestfs',
+                             title='Guestfs Options',
+                             help="""
+libguestfs is a set of tools for accessing and modifying virtual
+machine (VM) disk images. You can use this for viewing and editing
+files inside guests, scripting changes to VMs, monitoring disk
+used/free statistics, creating guests, P2V, V2V, performing backups,
+cloning VMs, building VMs, formatting disks and resizing disks.
 """)
 
-ALL_OPTS = [enable_guestfs_debug_opts]
+enable_guestfs_debug_opts = [
+    cfg.BoolOpt('debug',
+                default=False,
+                help="""
+Enable/disables guestfs logging.
+
+This configures guestfs to debug messages and push them to Openstack
+logging system. When set to True, it traces libguestfs API calls and
+enable verbose debug messages. In order to use the above feature,
+"libguestfs" package must be installed.
+
+Related options:
+Since libguestfs access and modifies VM's managed by libvirt, below options
+should be set to give access to those VM's.
+    * libvirt.inject_key
+    * libvirt.inject_partition
+    * libvirt.inject_password
+""")
+]
 
 
 def register_opts(conf):
-    conf.register_opts(ALL_OPTS, group="guestfs")
+    conf.register_group(guestfs_group)
+    conf.register_opts(enable_guestfs_debug_opts,
+                       group=guestfs_group)
 
 
 def list_opts():
-    return {"guestfs": ALL_OPTS}
+    return {guestfs_group: enable_guestfs_debug_opts}