summaryrefslogtreecommitdiffstats
path: root/documentation/toaster-manual/toaster-manual-intro.xml
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/toaster-manual/toaster-manual-intro.xml')
-rw-r--r--documentation/toaster-manual/toaster-manual-intro.xml111
1 files changed, 73 insertions, 38 deletions
diff --git a/documentation/toaster-manual/toaster-manual-intro.xml b/documentation/toaster-manual/toaster-manual-intro.xml
index 36c3b6bdc0..378f33420c 100644
--- a/documentation/toaster-manual/toaster-manual-intro.xml
+++ b/documentation/toaster-manual/toaster-manual-intro.xml
@@ -6,10 +6,13 @@
6<title>Introduction</title> 6<title>Introduction</title>
7 7
8 <para> 8 <para>
9 Toaster is an Application Programming Interface (API) and 9 Toaster is web interface to the OpenEmbedded build system, which uses
10 web-based interface to the OpenEmbedded build system, which uses
11 BitBake. 10 BitBake.
12 Both interfaces are based on a Representational State Transfer 11 The interface allows you to access a datastore that retains build
12 information and report out on the information.
13 </para>
14<!--THE FOLLOWING IS DETAIL THAT I THINK BELEN WANTED OUT FOR THE MOMENT
15 The interface is based on a Representational State Transfer
13 (REST) API that queries for and returns build information using 16 (REST) API that queries for and returns build information using
14 <filename>GET</filename> and <filename>JSON</filename>. 17 <filename>GET</filename> and <filename>JSON</filename>.
15 These types of search operations retrieve sets of objects from 18 These types of search operations retrieve sets of objects from
@@ -18,64 +21,95 @@
18 You can order the results of the search by key and the search 21 You can order the results of the search by key and the search
19 parameters are consistent for all object types. 22 parameters are consistent for all object types.
20 </para> 23 </para>
24-->
21 25
22 <para> 26 <para>
23 You can use Toaster in several different modes: 27 You can use Toaster in several different modes:
24 <itemizedlist> 28 <itemizedlist>
25 <listitem><para><emphasis>Interactive Mode:</emphasis> 29 <listitem><para><emphasis>Analysis Mode:</emphasis>
26 In this mode, you can record builds and statistics. 30 In this mode, you can record builds and statistics.
27 In Interactive Mode, you have direct access to the 31 In Analysis Mode, you have direct access to the
28 <filename>bitbake</filename> command, which you use to build 32 <filename>bitbake</filename> command, which you use to build
29 images. 33 images.</para>
34 <para>Analysis Mode requires you to have first started
35 Toaster and then to initiate your build using the
36 <filename>bitbake</filename> command from the shell.
37 Toaster must be started before the build or it will not
38 collect build data.
30 </para></listitem> 39 </para></listitem>
31 <listitem><para><emphasis>Managed Mode:</emphasis> 40 <listitem><para><emphasis>Build Mode:</emphasis>
32 In this mode, Toaster handles the build configuration GUI 41 In this mode, Toaster handles the build configuration GUI
33 (through Project pages) and build scheduling and execution. 42 (through project pages) and build scheduling and execution.
34 Additionally, in addition to these features, builds are 43 In this mode, all your interaction with the build system
35 triggered through the web interface. 44 happens through the web interface.
36 You do not have direct access to the 45 You do not have direct access to the
37 <filename>bitbake</filename> command.</para> 46 <filename>bitbake</filename> command.</para>
38 47 <para>Using this mode, you configure and start your builds
39 <para>Managed Mode also works two separate ways: Local 48 with Toaster's GUI.
40 Managed Mode and Remote Managed Mode. 49 Each configuration is a project, which requires version and
41 Local Managed Mode is the out-of-box mode available once 50 build system selection.
42 you checkout poky and allows you to perform builds on your 51 As shipped, Toaster supports the Yocto Project releases
43 local machine. 52 1.8 and beyond.
44 Remote Managed Mode, also known as Hosted Toaster, is a 53 Aside from these supported releases, you can also select
45 production setup best for organizations supporting multiple 54 the "Local Yocto Project", which allows you to use your
46 users and for organizations using customized Toaster 55 local clone of the Yocto Project
47 installations. 56 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
57 (e.g. <filename>poky</filename>).</para>
58 <para>Build Mode also works two separate ways: locally and
59 remotely.
60 While you can use Build Mode locally, it is best to use
61 Toaster's Build Mode through a hosted service where it can
62 shared by multiple user.
48 </para></listitem> 63 </para></listitem>
49 </itemizedlist> 64 </itemizedlist>
50 </para> 65 </para>
51 66
52 <para> 67 <para>
53 Using the interfaces you can do the following: 68 Using Toaster, you can do the following:
69 <note><title>REVIEWER NOTE</title>
70 Belen suggested we split this list out into things that
71 Analysis Mode and Build Mode can do.
72 Also, we can structure the lists so the Build Mode list
73 leverages off what is listed for Analysis Mode.
74 I do not know the information for the complete lists.
75 Someone needs to help me out here.
76 For now, I am leaving the list as follows and will need some
77 information.
78 </note>
54 <itemizedlist> 79 <itemizedlist>
55 <listitem><para>See information about the tasks executed 80 <listitem><para>
56 and reused during the build.</para></listitem> 81 See information about the tasks executed
57 <listitem><para>See what is built (recipes and 82 and reused during the build.
83 </para></listitem>
84 <listitem><para>
85 See what is built (recipes and
58 packages) and what packages were installed into the final 86 packages) and what packages were installed into the final
59 image.</para></listitem> 87 image.
60 <listitem><para>See performance-related information such 88 </para></listitem>
61 as build time, CPU usage, and disk I/O.</para></listitem> 89 <listitem><para>
62 <listitem><para>Examine error, warning and trace messages 90 See performance-related information such
63 to aid in debugging.</para></listitem> 91 as build time, CPU usage, and disk I/O.
92 </para></listitem>
93 <listitem><para>
94 Examine error, warning and trace messages
95 to aid in debugging.
96 </para></listitem>
64 </itemizedlist> 97 </itemizedlist>
65 </para> 98 </para>
66 99
67 <note> 100 <note>
68 <para> 101 <para>
69 This release of Toaster provides you with information 102 This release of Toaster does allow you to configure and initiate
70 about a BitBake run. 103 builds.
71 The tool does not allow you to configure and launch a build. 104 However, you cannot use Toaster to customize image recipes, which
72 However, future development includes plans to integrate the 105 still must either be done by hand or through
73 configuration and build launching capabilities of
74 <ulink url='&YOCTO_HOME_URL;/tools-resources/projects/hob'>Hob</ulink>. 106 <ulink url='&YOCTO_HOME_URL;/tools-resources/projects/hob'>Hob</ulink>.
107 As Toaster matures, it eventually will equal and surpass Hob
108 functionality, at which time Hob will be deprecated.
75 </para> 109 </para>
76 110
77 <para> 111 <para>
78 For more information on using Hob to build an image, 112 For more information on Hob,
79 see the 113 see the
80 "<ulink url='&YOCTO_DOCS_DEV_URL;#image-development-using-hob'>Image Development Using Hob</ulink>" 114 "<ulink url='&YOCTO_DOCS_DEV_URL;#image-development-using-hob'>Image Development Using Hob</ulink>"
81 section in the Yocto Project Development Manual. 115 section in the Yocto Project Development Manual.
@@ -85,6 +119,9 @@
85 <para> 119 <para>
86 The remainder of this manual describes what you need to have in 120 The remainder of this manual describes what you need to have in
87 place to use Toaster, how to start it, use it, and stop it. 121 place to use Toaster, how to start it, use it, and stop it.
122 </para>
123
124<!--THIS EXTRA INFORMATION PROBABLY WILL GO AWAY
88 For additional information on installing and running Toaster, see the 125 For additional information on installing and running Toaster, see the
89 "<ulink url='https://wiki.yoctoproject.org/wiki/Toaster#Installation_and_Running'>Installation and Running</ulink>" 126 "<ulink url='https://wiki.yoctoproject.org/wiki/Toaster#Installation_and_Running'>Installation and Running</ulink>"
90 section of the "Toaster" wiki page. 127 section of the "Toaster" wiki page.
@@ -93,7 +130,5 @@
93 <ulink url='https://wiki.yoctoproject.org/wiki/REST_API_Contracts'>REST API Contracts</ulink> 130 <ulink url='https://wiki.yoctoproject.org/wiki/REST_API_Contracts'>REST API Contracts</ulink>
94 Wiki page. 131 Wiki page.
95 </para> 132 </para>
96</chapter>
97<!--
98vim: expandtab tw=80 ts=4
99--> 133-->
134</chapter>