summaryrefslogtreecommitdiff
path: root/yocto-poky/documentation/toaster-manual/toaster-manual-intro.xml
diff options
context:
space:
mode:
Diffstat (limited to 'yocto-poky/documentation/toaster-manual/toaster-manual-intro.xml')
-rw-r--r--yocto-poky/documentation/toaster-manual/toaster-manual-intro.xml135
1 files changed, 60 insertions, 75 deletions
diff --git a/yocto-poky/documentation/toaster-manual/toaster-manual-intro.xml b/yocto-poky/documentation/toaster-manual/toaster-manual-intro.xml
index 9f4c38b2d..ee1dcbaba 100644
--- a/yocto-poky/documentation/toaster-manual/toaster-manual-intro.xml
+++ b/yocto-poky/documentation/toaster-manual/toaster-manual-intro.xml
@@ -14,111 +14,98 @@
remote build servers.
</para>
- <note>
- <para>
- 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
- <ulink url='&YOCTO_HOME_URL;/tools-resources/projects/hob'>Hob</ulink>.
- As Toaster matures, it eventually will equal and surpass Hob
- functionality, at which time Hob will be deprecated.
- </para>
+ <section id='intro-features'>
+ <title>Toaster Features</title>
<para>
- For more information on Hob,
- see the
- "<ulink url='&YOCTO_DOCS_DEV_URL;#image-development-using-hob'>Image Development Using Hob</ulink>"
- section in the Yocto Project Development Manual.
- </para>
- </note>
-
- <section id='intro-modes'>
- <title>Toaster Operational Modes</title>
-
- <para>
- You can use Toaster in Analysis Mode or Build Mode:
+ Toaster 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 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:
<itemizedlist>
<listitem><para>
- See what was built (recipes and packages) and what
- packages were installed into your final image.
+ 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 the directory structure of your image.
+ Browse images, recipes, and machines provided by
+ those layers.
</para></listitem>
<listitem><para>
- See the value of all variables in your build
- configuration, and which files set each value.
+ Import your own layers for building.
</para></listitem>
<listitem><para>
- Examine error, warning and trace messages to aid
- in debugging.
+ Add and remove layers from your configuration.
</para></listitem>
<listitem><para>
- See information about the BitBake tasks executed
- and reused during your build, including those that
- used shared state.
+ Set configuration variables.
</para></listitem>
<listitem><para>
- See dependency relationships between recipes,
- packages and tasks
+ Select a target or multiple targets to build.
</para></listitem>
<listitem><para>
- See performance information such as build time,
- task time, CPU usage, and disk I/O.
+ Start your builds.
</para></listitem>
</itemizedlist>
+ 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".
</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:
+ <listitem><para id='toaster-analysis-features'>
+ <emphasis>Information About the Build Process:</emphasis>
+ 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.
+ <note>
+ You must start Toaster before the build or it will not
+ collect build data.
+ </note></para>
+ <para>With Toaster 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>).
+ See what was built (recipes and packages) and what
+ packages were installed into your final image.
</para></listitem>
<listitem><para>
- Import your own layers for building.
+ Browse the directory structure of your image.
</para></listitem>
<listitem><para>
- Add and remove layers from your configuration.
+ See the value of all variables in your build
+ configuration, and which files set each value.
</para></listitem>
<listitem><para>
- Set configuration variables.
+ Examine error, warning, and trace messages to aid
+ in debugging.
</para></listitem>
<listitem><para>
- 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.
</para></listitem>
<listitem><para>
- Start your builds.
+ See dependency relationships between recipes,
+ packages, and tasks.
+ </para></listitem>
+ <listitem><para>
+ See performance information such as build time,
+ task time, CPU usage, and disk I/O.
</para></listitem>
</itemizedlist>
</para></listitem>
@@ -132,8 +119,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>