From a1a4808dc69de8fe12e53b302663b42a560c1788 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Fri, 5 Feb 2016 14:09:06 -0800 Subject: toaster-manual: Applied a patch to weed out build mode (modes). (From yocto-docs rev: 3013ced298115dd7567e7311a0c0e98626cb139d) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- .../toaster-manual/toaster-manual-intro.xml | 116 +++++++++++---------- .../toaster-manual/toaster-manual-reference.xml | 40 +++---- 2 files changed, 72 insertions(+), 84 deletions(-) (limited to 'documentation/toaster-manual') diff --git a/documentation/toaster-manual/toaster-manual-intro.xml b/documentation/toaster-manual/toaster-manual-intro.xml index 9f4c38b2d4..5dd05ef4f9 100644 --- a/documentation/toaster-manual/toaster-manual-intro.xml +++ b/documentation/toaster-manual/toaster-manual-intro.xml @@ -33,92 +33,98 @@ -
- Toaster Operational Modes +
+ Toaster Features - You can use Toaster in Analysis Mode or Build Mode: + Toaster allows allows you to configure and run builds, and it + provides extensive information about the build process. - 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: + + Configure and Run Builds: + You can use the Toaster web interface to configure and + start your builds. + Builds started using the Toaster web interface are + organized into projects. + When you create a project, you are asked to select a + release, or version of the build system you want to + use for the project builds. + As shipped, Toaster supports Yocto Project releases 1.8 + and beyond. + With the Toaster web interface, you can: - See what was built (recipes and packages) and what - packages were installed into your final image. + Browse layers listed in the various + layer sources + that are available in your project (e.g. the + OpenEmbedded Metadata Index at + ). - Browse the directory structure of your image. + Browse images, recipes, and machines provided by + those layers. - See the value of all variables in your build - configuration, and which files set each value. + Import your own layers for building. - Examine error, warning and trace messages to aid - in debugging. + Add and remove layers from your configuration. - See information about the BitBake tasks executed - and reused during your build, including those that - used shared state. + Set configuration variables. - See dependency relationships between recipes, - packages and tasks + Select a target or multiple targets to build. - See performance information such as build time, - task time, CPU usage, and disk I/O. + Start your builds. + Toaster also allows you to configure and run your builds + from the command line, and switch between the command line and + the web interface at any time. + Builds started from the command line appear within a special + Toaster project called "Command line builds". - 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: + + Information About the Build Process: + Toaster also records extensive information about your builds. + Toaster collects data for builds you start from the web + interface and from the command line as long as Toaster + is running. + + You must start Toaster before the build or it will not + collect build data. + + With Toaster you can: - Browse layers listed in the various - layer sources - that are available in your project (e.g. the - OpenEmbedded Metadata Index at - ). + See what was built (recipes and packages) and what + packages were installed into your final image. - Import your own layers for building. + Browse the directory structure of your image. - Add and remove layers from your configuration. + See the value of all variables in your build + configuration, and which files set each value. - Set configuration variables. + Examine error, warning, and trace messages to aid + in debugging. - Select a target or multiple targets to build. + See information about the BitBake tasks executed + and reused during your build, including those that + used shared state. - Start your builds. + See dependency relationships between recipes, + packages, and tasks. + + + See performance information such as build time, + task time, CPU usage, and disk I/O. @@ -132,8 +138,6 @@ 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. diff --git a/documentation/toaster-manual/toaster-manual-reference.xml b/documentation/toaster-manual/toaster-manual-reference.xml index faca4ca73a..715f2915c8 100644 --- a/documentation/toaster-manual/toaster-manual-reference.xml +++ b/documentation/toaster-manual/toaster-manual-reference.xml @@ -159,12 +159,15 @@ - When you set up Toaster in Build Mode, you are prompted - to select a Toaster configuration file. + The Toaster startup script in + /bitbake/bin/toaster specifies + the location of a Toaster configuration file + toasterconf.json as the value of + the TOASTER_CONF variable. This configuration file is used to set up the initial configuration values within the Toaster database including the layer sources. - Three versions of the configuration file exist: + Two versions of the configuration file exist: The first version of the file is found in the @@ -192,14 +195,6 @@ (i.e. git://git.openembedded.org/openembedded-core). - - The third version is a sample configuration - useful for when you want to set up a hosted - service in Build Mode. - You can find this version on the - File:Toasterconf.json.txt.patch - wiki page. -
@@ -550,8 +545,7 @@ JSON Files - If you are going to be using Toaster in Build Mode, it must - be initially configured before use. + You must configure Toaster before using it. Configuration customizes layer source settings and Toaster defaults for all users and is performed by the person responsible for Toaster Configuration (i.e the Toaster Administrator). @@ -577,17 +571,16 @@ toasterconf.json. The Toaster Administrator can customize the file prior to loading it into Toaster. - When you set up Toaster locally to run in Build Mode, the system - startup script actively looks for compatible configuration files - and prompts you to select a file to load if it detects that the - database has not been configured. + The TOASTER_CONF variable in the + Toaster startup script at bitbake/bin/toaster + specifies the location of the toasterconf.json file.
Configuration File Choices - Three versions of the configuration file exist: + Two versions of the configuration file exist: The @@ -613,15 +606,6 @@ openembedded-core repository (i.e. git://git.openembedded.org/openembedded-core). - - The Toasterconf.json.txt.patch - located on the - File:Toasterconf.json.txt.patch - wiki page. - This version of the file is useful as a sample - configuration for when you want to set up Toaster as a - hosted service in Build Mode. -
@@ -1008,7 +992,7 @@ $ bitbake/lib/toaster/manage.py checksettings - In Build Mode, Toaster uses settings that are based on the + Toaster uses settings that are based on the database to configure the building tasks. The checksettings command verifies that the database settings are valid in the sense that they have -- cgit 1.2.3-korg