From: Steven Dake <sdake@redhat.com>
Date: Thu, 5 Apr 2012 18:42:36 +0000 (-0700)
Subject: Add documentation for heat jeos_create function
X-Git-Tag: 2014.1~2078
X-Git-Url: https://review.fuel-infra.org/gitweb?a=commitdiff_plain;h=22c2dde2ac808c997150941440156b52fc8d328b;p=openstack-build%2Fheat-build.git

Add documentation for heat jeos_create function

Partially Fixes issue #58

Signed-off-by: Steven Dake <sdake@redhat.com>
---

diff --git a/bin/heat b/bin/heat
index b5e4dc36..83b4e008 100755
--- a/bin/heat
+++ b/bin/heat
@@ -214,6 +214,17 @@ def stack_list(options, arguments):
 @catch_error('jeos_create')
 def jeos_create(options, arguments):
     '''
+    The jeos_create option must be run as root.  This command takes three
+    arguments that are popped from the arguments parameter.
+    arg0 -> Distribution such as 'F16', 'F17', 'U10', 'D6'
+    arg1 -> Architecture such as 'i386' 'i686' or 'x86_64'
+    arg2 -> Image type such as 'gold' or 'cftools'
+
+    gold is a basic gold JEOS
+    cftools contains the cfntools helper scripts
+
+    The command must be run as root in order for libvirt to have permissions
+    to create virtual machines and read the raw DVDs.
     '''
     global jeos_path