[Toaster] [review-request] [PATCH] toaster-manual: Improve the explanation of TOASTER_DIR and checksettings

Belen Barros Pena belen.barros.pena at linux.intel.com
Tue Feb 2 09:28:39 PST 2016


From: Belen Barros Pena <belen.barros.pena at intel.com>

In section 3.6 of the manual about setting up a production instance of
Toaster, explain that TOASTER_DIR determines the location of the build
directory, and that the checksettings command configures the build
environment for Toaster.

Signed-off-by: Belen Barros Pena <belen.barros.pena at intel.com>
---
 .../toaster-manual-setup-and-use.xml               | 31 ++++++++++++++++++----
 1 file changed, 26 insertions(+), 5 deletions(-)

diff --git a/documentation/toaster-manual/toaster-manual-setup-and-use.xml b/documentation/toaster-manual/toaster-manual-setup-and-use.xml
index 3ac1654..447984f 100644
--- a/documentation/toaster-manual/toaster-manual-setup-and-use.xml
+++ b/documentation/toaster-manual/toaster-manual-setup-and-use.xml
@@ -328,15 +328,36 @@
 
                         <para>
                             The next line sets the Toaster root directory
-                            <filename>TOASTER_DIR</filename>, and the location of
-                            the Toaster configuration file <filename>TOASTER_CONF</filename>,
-                            relative to the root directory. For more information on the
-                            Toaster configuration file see the
-                            "<link linkend='toaster-json-files'>JSON Files</link>"
+                            <filename>TOASTER_DIR</filename> and the location of
+                            the Toaster configuration file
+                            <filename>TOASTER_CONF</filename>, which is
+                            relative to the Toaster root directory
+                            <filename>TOASTER_DIR</filename>. For more
+                            information on the Toaster configuration file
+                            <filename>TOASTER_CONF</filename> see the
+                            <link linkend='toaster-json-files'>JSON Files</link>
                             section of this manual.
                         </para>
 
                         <para>
+                            This line also runs the <filename>checksettings</filename>
+                            command, which configures the location of the Toaster
+                            <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build directory</ulink>.
+                            The Toaster root directory <filename>TOASTER_DIR</filename>
+                            determines where the Toaster build directory
+                            is created on the file system. In the example above,
+                            <filename>TOASTER_DIR</filename> is set to
+                            <literallayout class="monospaced">
+     /var/wwww/toaster/poky
+                            </literallayout>
+                            This means that the Toaster build directory will be
+                            set to
+                            <literallayout class="monospaced">
+     /var/www/toaster/poky/build
+                            </literallayout>
+                        </para>
+
+                        <para>
                             Finally, the <filename>collectstatic</filename> command
                             is a Django framework command that collects all the
                             statically served files into a designated directory to
-- 
2.5.4 (Apple Git-61)



More information about the toaster mailing list