From 586992d24e3f0b8d0dfa194f7609fae0364ec390 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Fri, 13 Feb 2015 07:48:24 -0800 Subject: toaster-manual: 2nd draft for review. Fixes [YOCTO #6901] This is the 2nd review draft of the manual. (From yocto-docs rev: 9f541e4421e0e74e59e3b3da1896b6c1254daf08) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- .../toaster-manual/toaster-manual-intro.xml | 111 ++++++++++++++------- 1 file changed, 73 insertions(+), 38 deletions(-) (limited to 'documentation/toaster-manual/toaster-manual-intro.xml') 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 @@ Introduction - Toaster is an Application Programming Interface (API) and - web-based interface to the OpenEmbedded build system, which uses + Toaster is web interface to the OpenEmbedded build system, which uses BitBake. - Both interfaces are based on a Representational State Transfer + The interface allows you to access a datastore that retains build + information and report out on the information. + + You can use Toaster in several different modes: - Interactive Mode: + Analysis Mode: In this mode, you can record builds and statistics. - In Interactive Mode, you have direct access to the + In Analysis Mode, you have direct access to the bitbake command, which you use to build - images. + images. + Analysis Mode requires you to have first started + Toaster and then to initiate your build using the + bitbake command from the shell. + Toaster must be started before the build or it will not + collect build data. - Managed Mode: + Build Mode: In this mode, Toaster handles the build configuration GUI - (through Project pages) and build scheduling and execution. - Additionally, in addition to these features, builds are - triggered through the web interface. + (through project pages) and build scheduling and execution. + In this mode, all your interaction with the build system + happens through the web interface. You do not have direct access to the bitbake command. - - Managed Mode also works two separate ways: Local - Managed Mode and Remote Managed Mode. - Local Managed Mode is the out-of-box mode available once - you checkout poky and allows you to perform builds on your - local machine. - Remote Managed Mode, also known as Hosted Toaster, is a - production setup best for organizations supporting multiple - users and for organizations using customized Toaster - installations. + Using this mode, you configure and start your builds + with Toaster's GUI. + Each configuration is a project, which requires version and + build system selection. + As shipped, Toaster supports the Yocto Project releases + 1.8 and beyond. + Aside from these supported releases, you can also select + the "Local Yocto Project", which allows you to use your + local clone of the Yocto Project + Source Directory + (e.g. poky). + Build Mode also works two separate ways: locally and + remotely. + While you can use Build Mode locally, it is best to use + Toaster's Build Mode through a hosted service where it can + shared by multiple user. - Using the interfaces you can do the following: + Using Toaster, you can do the following: + REVIEWER NOTE + Belen suggested we split this list out into things that + Analysis Mode and Build Mode can do. + Also, we can structure the lists so the Build Mode list + leverages off what is listed for Analysis Mode. + I do not know the information for the complete lists. + Someone needs to help me out here. + For now, I am leaving the list as follows and will need some + information. + - See information about the tasks executed - and reused during the build. - See what is built (recipes and + + See information about the tasks executed + and reused during the build. + + + See what is built (recipes and packages) and what packages were installed into the final - image. - See performance-related information such - as build time, CPU usage, and disk I/O. - Examine error, warning and trace messages - to aid in debugging. + image. + + + See performance-related information such + as build time, CPU usage, and disk I/O. + + + Examine error, warning and trace messages + to aid in debugging. + - This release of Toaster provides you with information - about a BitBake run. - The tool does not allow you to configure and launch a build. - However, future development includes plans to integrate the - configuration and build launching capabilities of + This release of Toaster does allow you to configure and initiate + builds. + However, you cannot use Toaster to customize image recipes, which + still must either be done by hand or through Hob. + As Toaster matures, it eventually will equal and surpass Hob + functionality, at which time Hob will be deprecated. - For more information on using Hob to build an image, + For more information on Hob, see the "Image Development Using Hob" section in the Yocto Project Development Manual. @@ -85,6 +119,9 @@ The remainder of this manual describes what you need to have in place to use Toaster, how to start it, use it, and stop it. + + + + -- cgit v1.2.3-54-g00ecf