From 56e0326d42468bfaba640fa1d63664c5fd983639 Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
Date: Tue, 13 Aug 2013 08:46:21 +0300
Subject: dev-manual: udates to toaster section.

Fixes [YOCTO #4730]

Edits to the new section on toaster.  These are from Belen's review.

(From yocto-docs rev: f1462bd53bf39c706a87af86830a92b451b3e00c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---
 .../dev-manual/dev-manual-common-tasks.xml         | 30 +++++++++++++++++-----
 1 file changed, 23 insertions(+), 7 deletions(-)

(limited to 'documentation')

diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index d5c97c0538..7fa9149d07 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -4333,15 +4333,15 @@
             to a specific target.
             Using Toaster, you can do the following:
             <itemizedlist>
-                <listitem><para>Understand why a task fails or was
-                    reused from the shared state cache when you thought it
-                    should have been rebuilt from scratch.</para></listitem>
+                <listitem><para>See information about the tasks executed
+                    and reused during the build.</para></listitem>
                 <listitem><para>See what is built (recipes and
                     packages) and what packages were installed into the final
                     image.</para></listitem>
                 <listitem><para>See performance-related information such
-                    as size, build time, CPU usage, disk input, and disk
-                    output.</para></listitem>
+                    as build time, CPU usage, and disk I/O.</para></listitem>
+                <listitem><para>Examine error, warning and trace messages
+                    to aid in debugging.</para></listitem>
             </itemizedlist>
         </para>
 
@@ -4393,6 +4393,10 @@
                         <literallayout class='monospaced'>
      $ source toaster start
                         </literallayout></para></listitem>
+                        <note>
+                            The Toaster must be started and running in order
+                            for it to collect data.
+                        </note>
                 </orderedlist>
             </para>
 
@@ -4446,6 +4450,19 @@
             <para>
                 The Toaster database is persistent regardless of whether you
                 start or stop the service.
+            </para>
+
+            <para>
+                Toaster's interface shows you a list of builds
+                (successful and unsuccessful) for which it has data.
+                You can click on any build to see related information.
+                This information includes configuration details, information
+                about tasks, all recipes and packages built and their
+                dependencies, packages installed in your final image,
+                execution time, CPU usage and disk I/O per task.
+            </para>
+
+<!--
                 The home page of the interface into the database organizes
                 builds into areas:
                 <itemizedlist>
@@ -4458,8 +4475,6 @@
                     <listitem><para>All builds, which appear in row format at
                         the end of the page.</para></listitem>
                 </itemizedlist>
-            </para>
-
             <para>
                 Each entry is linked to more detail on the particular build
                 or recipe.
@@ -4477,6 +4492,7 @@
                 task, and package information along with directory structure,
                 build time, CPU usage, and disk I/O information.
             </para>
+-->
         </section>
 
         <section id='stopping-toaster'>
-- 
cgit v1.2.3-54-g00ecf