From 9087f2488124a2ba7b87ef9c4ec3c8b044dce8bb Mon Sep 17 00:00:00 2001
From: ricolin <rico.l@inwinstack.com>
Date: Sun, 8 Jan 2017 00:34:18 +0800
Subject: [PATCH] Add note for env prepare of `Custom image script`

Add note for `Custom image script` to make sure everyone
aware of requirements of environment before running the scripts.
Closes-Bug: #1651237

Change-Id: Ic9874765ff3d1925c4edf3b2b1b766cddaee550a
---
 doc/source/template_guide/software_deployment.rst | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/doc/source/template_guide/software_deployment.rst b/doc/source/template_guide/software_deployment.rst
index 80e7a78568..42892d5c4a 100644
--- a/doc/source/template_guide/software_deployment.rst
+++ b/doc/source/template_guide/software_deployment.rst
@@ -513,6 +513,10 @@ required in later examples:
     glance image-create --disk-format qcow2 --container-format bare \
         --name $IMAGE_NAME < $IMAGE_NAME.qcow2
 
+.. note:: Above script uses diskimage-builder, make sure the environment
+          already fulfill all requirements in requirements.txt of
+          diskimage-builder.
+
 
 Configuring with scripts
 ------------------------