diff options
| -rw-r--r-- | documentation/toaster-manual/toaster-manual-intro.xml | 110 | ||||
| -rw-r--r-- | documentation/toaster-manual/toaster-manual-reference.xml | 38 |
2 files changed, 62 insertions, 86 deletions
diff --git a/documentation/toaster-manual/toaster-manual-intro.xml b/documentation/toaster-manual/toaster-manual-intro.xml index 9f4c38b2d4a..b6e11d8b1db 100644 --- a/documentation/toaster-manual/toaster-manual-intro.xml +++ b/documentation/toaster-manual/toaster-manual-intro.xml @@ -33,24 +33,60 @@ </para> </note> - <section id='intro-modes'> - <title>Toaster Operational Modes</title> + <section id='intro-features'> + <title>Toaster Features</title> <para> - You can use Toaster in Analysis Mode or Build Mode: + Toaster does mainly two things: it allows you to configure and run builds, and it provides + extensive information about the build process. <itemizedlist> - <listitem><para id='toaster-analysis-mode'><emphasis>Analysis Mode:</emphasis> - In Analysis Mode, you can record builds and statistics. - In this Mode, you directly access the - <filename>bitbake</filename> command, which you then use to - build images.</para> - <para>Analysis Mode requires you to have first started - Toaster and then to initiate your build using the - <filename>bitbake</filename> command from the shell. - Toaster must be started before the build or it will not - collect build data.</para> - <para>Toaster has the following capabilities in - Analysis Mode: + <listitem><para id='toaster-build-features'><emphasis>Configure and run builds:</emphasis> + You can use the Toaster web interface to configure and start your builds. + Builds started via the Toaster web interface are organised into projects. + When you create a project, you will be 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.</para> + <para>With the Toaster web interface, you can: + <itemizedlist> + <listitem><para> + Browse layers listed in the various + <link linkend='layer-source'>layer sources</link> + that are available in your project (e.g. the + OpenEmbedded Metadata Index at + <ulink url='http://layers.openembedded.org/layerindex/'></ulink>). + </para></listitem> + <listitem><para> + Browse images, recipes and machines provided by + those layers.</para></listitem> + <listitem><para> + Import your own layers for building. + </para></listitem> + <listitem><para> + Add and remove layers from your configuration. + </para></listitem> + <listitem><para> + Set configuration variables. + </para></listitem> + <listitem><para> + Select a target or multiple targets to build. + </para></listitem> + <listitem><para> + Start your builds. + </para></listitem> + </itemizedlist></para> + <para>Toaster also allows you to configure and run your builds + from command line, and switch between command line and web + interface at any time. Builds started from command line are + shown within a special Toaster project called "Command line + builds".</para> + </listitem> + <listitem><para id='toaster-analysis-features'><emphasis>Information about the build + process:</emphasis> + Toaster also records extensive information about your builds. Data + is collected for builds started from the web interface and the command + line, <emphasis>as long as Toaster is running</emphasis>. Toaster must + be started before the build or it will not collect build data.</para> + <para>With Toaster you can: <itemizedlist> <listitem><para> See what was built (recipes and packages) and what @@ -74,7 +110,7 @@ </para></listitem> <listitem><para> See dependency relationships between recipes, - packages and tasks + packages and tasks. </para></listitem> <listitem><para> See performance information such as build time, @@ -82,46 +118,6 @@ </para></listitem> </itemizedlist> </para></listitem> - <listitem><para id='toaster-build-mode'><emphasis>Build Mode:</emphasis> - 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 - <filename>bitbake</filename> command.</para> - <para>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.</para> - <para>Toaster has all the same capabilities in Build Mode - as it does in Analysis Mode plus the following: - <itemizedlist> - <listitem><para> - Browse layers listed in the various - <link linkend='layer-source'>layer sources</link> - that are available in your project (e.g. the - OpenEmbedded Metadata Index at - <ulink url='http://layers.openembedded.org/layerindex/'></ulink>). - </para></listitem> - <listitem><para> - Import your own layers for building. - </para></listitem> - <listitem><para> - Add and remove layers from your configuration. - </para></listitem> - <listitem><para> - Set configuration variables. - </para></listitem> - <listitem><para> - Select a target or multiple targets to build. - </para></listitem> - <listitem><para> - Start your builds. - </para></listitem> - </itemizedlist> - </para></listitem> </itemizedlist> </para> </section> @@ -132,8 +128,6 @@ <para> 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. </para> <para> diff --git a/documentation/toaster-manual/toaster-manual-reference.xml b/documentation/toaster-manual/toaster-manual-reference.xml index faca4ca73af..ee171dc9b40 100644 --- a/documentation/toaster-manual/toaster-manual-reference.xml +++ b/documentation/toaster-manual/toaster-manual-reference.xml @@ -159,12 +159,13 @@ </para> <para> - When you set up Toaster in Build Mode, you are prompted - to select a Toaster configuration file. + The Toaster startup script in <filename>/bitbake/bin/toaster</filename> specifies + the location of a Toaster configuration file <filename>toasterconf.json</filename> + as the value of the <filename>TOASTER_CONF</filename> 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: <itemizedlist> <listitem><para> The first version of the file is found in the @@ -192,14 +193,6 @@ (i.e. <filename>git://git.openembedded.org/openembedded-core</filename>). </para></listitem> - <listitem><para> - 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 - <ulink url='https://wiki.yoctoproject.org/wiki/File:Toasterconf.json.txt.patch'>File:Toasterconf.json.txt.patch</ulink> - wiki page. - </para></listitem> </itemizedlist> </para> </section> @@ -550,8 +543,7 @@ <title>JSON Files</title> <para> - If you are going to be using Toaster in Build Mode, it must - be initially configured before use. + Toaster must be configured before use. 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 +569,16 @@ <filename>toasterconf.json</filename>. 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 location of the <filename>toasterconf.json</filename> file is + specified by the <filename>TOASTER_CONF</filename> variable in the + Toaster startup script at <filename>bitbake/bin/toaster</filename>. </para> <section id='json-file-choices'> <title>Configuration File Choices</title> <para> - Three versions of the configuration file exist: + Two versions of the configuration file exist: <itemizedlist> <listitem><para> The @@ -613,15 +604,6 @@ <filename>openembedded-core</filename> repository (i.e. <filename>git://git.openembedded.org/openembedded-core</filename>). </para></listitem> - <listitem><para> - The <filename>Toasterconf.json.txt.patch</filename> - located on the - <ulink url='https://wiki.yoctoproject.org/wiki/File:Toasterconf.json.txt.patch'>File:Toasterconf.json.txt.patch</ulink> - 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. - </para></listitem> </itemizedlist> </para> </section> @@ -1008,7 +990,7 @@ <literallayout class='monospaced'> $ bitbake/lib/toaster/manage.py checksettings </literallayout> - 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 <filename>checksettings</filename> command verifies that the database settings are valid in the sense that they have |