From 853b697afaf07cc847a31d27d87d3d14803029ee Mon Sep 17 00:00:00 2001
From: Stephen Finucane <stephen.finucane@intel.com>
Date: Thu, 14 Jan 2016 10:40:08 +0000
Subject: [PATCH] Improve 'virt.images' conf options documentation

Change-Id: I8a141be79eabc186417f535bc628b8171701e91b
Implements: bp centralize-config-options
---
 nova/conf/virt.py | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/nova/conf/virt.py b/nova/conf/virt.py
index 0b9262d01948..601a48883801 100644
--- a/nova/conf/virt.py
+++ b/nova/conf/virt.py
@@ -185,7 +185,21 @@ Interdependencies to other options:
 force_raw_images = cfg.BoolOpt(
     'force_raw_images',
     default=True,
-    help='Force backing images to raw format')
+    help="""Force conversion of backing images to raw format.
+
+Possible values:
+
+* True: Backing image files will be converted to raw image format
+* False: Backing image files will not be converted
+
+Services which consume this:
+
+* nova-compute
+
+Interdependencies to other options:
+
+* ``compute_driver``: Only the libvirt driver uses this option.
+""")
 
 ALL_OPTS = [vcpu_pin_set,
             compute_driver,