diff --git a/documentation/template/embedded_video.xsl b/documentation/template/embedded_video.xsl new file mode 100644 index 0000000000..dfb33c3441 --- /dev/null +++ b/documentation/template/embedded_video.xsl @@ -0,0 +1,22 @@ + + + + + + + + + + +
+ + + + + +
+
+
+
diff --git a/documentation/toaster-manual/figures/hosted-service.png b/documentation/toaster-manual/figures/hosted-service.png new file mode 100644 index 0000000000..01fea7b245 Binary files /dev/null and b/documentation/toaster-manual/figures/hosted-service.png differ diff --git a/documentation/toaster-manual/figures/simple-configuration.png b/documentation/toaster-manual/figures/simple-configuration.png new file mode 100644 index 0000000000..e8fce2bf18 Binary files /dev/null and b/documentation/toaster-manual/figures/simple-configuration.png differ diff --git a/documentation/toaster-manual/toaster-manual-customization.xsl b/documentation/toaster-manual/toaster-manual-customization.xsl index e253aedd9a..29d29c452e 100644 --- a/documentation/toaster-manual/toaster-manual-customization.xsl +++ b/documentation/toaster-manual/toaster-manual-customization.xsl @@ -1,13 +1,15 @@ - + + + diff --git a/documentation/toaster-manual/toaster-manual-intro.xml b/documentation/toaster-manual/toaster-manual-intro.xml index 378f33420c..ad9e08b50d 100644 --- a/documentation/toaster-manual/toaster-manual-intro.xml +++ b/documentation/toaster-manual/toaster-manual-intro.xml @@ -6,95 +6,12 @@ Introduction - Toaster is web interface to the OpenEmbedded build system, which uses - BitBake. - 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: - - Analysis Mode: - In this mode, you can record builds and statistics. - In Analysis Mode, you have direct access to the - bitbake command, which you use to build - 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. - - Build Mode: - In this mode, Toaster handles the build configuration GUI - (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. - 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 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 - 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. - - + Toaster is a web interface to the Yocto Project's + OpenEmbedded build system. + The interface enables you to configure and run your builds. + Information about builds is collected and stored in a database. + You can use Toaster to configure and start builds on multiple + remote build servers. @@ -116,10 +33,131 @@ - - 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. - +
+ Toaster Operational Modes + + + You can use Toaster in Analysis Mode or Build Mode: + + Analysis Mode: + In Analysis Mode, you can record builds and statistics. + In this Mode, you directly access the + bitbake command, which you then use to + build 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. + Toaster has the following capabilities in + Analysis Mode: + + + See what was built (recipes and packages) and what + packages were installed into your final image. + + + Browse the directory structure of your image. + + + See the value of all variables in your build + configuration, and which files set each value. + + + Examine error, warning and trace messages to aid + in debugging. + + + See information about the BitBake tasks executed + and reused during your build, including those that + used shared state. + + + See dependency relationships between recipes, + packages and tasks + + + See performance information such as build time, + task time, CPU usage, and disk I/O. + + + + Build Mode: + In Build Mode, Toaster handles the build configuration, + 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. + Using this mode, you configure and start your builds + within Toaster's GUI. + Each project can be configured for a specific version + of the build system. + As shipped, Toaster supports Yocto Project Releases 1.7 and + beyond. + Toaster has all the same capabilities in Build Mode + as it does in Analysis Mode plus the following: + + + Browse layers listed in the various + layer sources + that are available in your project (e.g. the + OpenEmbedded Metadata Index at + ). + + + Import your own layers for building. + + + Add and remove layers from your configuration. + + + Set configuration variables. + + + Select a target or multiple targets to build. + + + Start your builds. + + + + + +
+ +
+ Installation Options + + + You can set Toaster up to run as a local instance or as a shared + hosted service. + Regardless of how you set up Toaster, both Analysis and Build + Modes are available. + + + + When Toaster is set up as a local instance, all the components + reside on a single build host. + Fundamentally, a local instance of Toaster is suited for a single + user developing on a single build host. + + + + + + + + Toaster as a hosted service is suited for multiple users + developing across several build hosts. + When Toaster is set up as a hosted service, its components can + be spread across several machines: + + + + + +