diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2016-02-05 14:09:06 -0800 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2016-03-03 17:40:10 +0000 |
commit | a1a4808dc69de8fe12e53b302663b42a560c1788 (patch) | |
tree | 2ca43195c493a7b4c5fb5a3459bb8b81de5a509f /documentation/toaster-manual | |
parent | 353b7551770cca5d726405001b14c676681d920a (diff) | |
download | poky-a1a4808dc69de8fe12e53b302663b42a560c1788.tar.gz |
toaster-manual: Applied a patch to weed out build mode (modes).
(From yocto-docs rev: 3013ced298115dd7567e7311a0c0e98626cb139d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/toaster-manual')
-rw-r--r-- | documentation/toaster-manual/toaster-manual-intro.xml | 116 | ||||
-rw-r--r-- | documentation/toaster-manual/toaster-manual-reference.xml | 40 |
2 files changed, 72 insertions, 84 deletions
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 @@ | |||
33 | </para> | 33 | </para> |
34 | </note> | 34 | </note> |
35 | 35 | ||
36 | <section id='intro-modes'> | 36 | <section id='intro-features'> |
37 | <title>Toaster Operational Modes</title> | 37 | <title>Toaster Features</title> |
38 | 38 | ||
39 | <para> | 39 | <para> |
40 | You can use Toaster in Analysis Mode or Build Mode: | 40 | Toaster allows allows you to configure and run builds, and it |
41 | provides extensive information about the build process. | ||
41 | <itemizedlist> | 42 | <itemizedlist> |
42 | <listitem><para id='toaster-analysis-mode'><emphasis>Analysis Mode:</emphasis> | 43 | <listitem><para id='toaster-build-features'> |
43 | In Analysis Mode, you can record builds and statistics. | 44 | <emphasis>Configure and Run Builds:</emphasis> |
44 | In this Mode, you directly access the | 45 | You can use the Toaster web interface to configure and |
45 | <filename>bitbake</filename> command, which you then use to | 46 | start your builds. |
46 | build images.</para> | 47 | Builds started using the Toaster web interface are |
47 | <para>Analysis Mode requires you to have first started | 48 | organized into projects. |
48 | Toaster and then to initiate your build using the | 49 | When you create a project, you are asked to select a |
49 | <filename>bitbake</filename> command from the shell. | 50 | release, or version of the build system you want to |
50 | Toaster must be started before the build or it will not | 51 | use for the project builds. |
51 | collect build data.</para> | 52 | As shipped, Toaster supports Yocto Project releases 1.8 |
52 | <para>Toaster has the following capabilities in | 53 | and beyond. |
53 | Analysis Mode: | 54 | With the Toaster web interface, you can: |
54 | <itemizedlist> | 55 | <itemizedlist> |
55 | <listitem><para> | 56 | <listitem><para> |
56 | See what was built (recipes and packages) and what | 57 | Browse layers listed in the various |
57 | packages were installed into your final image. | 58 | <link linkend='layer-source'>layer sources</link> |
59 | that are available in your project (e.g. the | ||
60 | OpenEmbedded Metadata Index at | ||
61 | <ulink url='http://layers.openembedded.org/layerindex/'></ulink>). | ||
58 | </para></listitem> | 62 | </para></listitem> |
59 | <listitem><para> | 63 | <listitem><para> |
60 | Browse the directory structure of your image. | 64 | Browse images, recipes, and machines provided by |
65 | those layers. | ||
61 | </para></listitem> | 66 | </para></listitem> |
62 | <listitem><para> | 67 | <listitem><para> |
63 | See the value of all variables in your build | 68 | Import your own layers for building. |
64 | configuration, and which files set each value. | ||
65 | </para></listitem> | 69 | </para></listitem> |
66 | <listitem><para> | 70 | <listitem><para> |
67 | Examine error, warning and trace messages to aid | 71 | Add and remove layers from your configuration. |
68 | in debugging. | ||
69 | </para></listitem> | 72 | </para></listitem> |
70 | <listitem><para> | 73 | <listitem><para> |
71 | See information about the BitBake tasks executed | 74 | Set configuration variables. |
72 | and reused during your build, including those that | ||
73 | used shared state. | ||
74 | </para></listitem> | 75 | </para></listitem> |
75 | <listitem><para> | 76 | <listitem><para> |
76 | See dependency relationships between recipes, | 77 | Select a target or multiple targets to build. |
77 | packages and tasks | ||
78 | </para></listitem> | 78 | </para></listitem> |
79 | <listitem><para> | 79 | <listitem><para> |
80 | See performance information such as build time, | 80 | Start your builds. |
81 | task time, CPU usage, and disk I/O. | ||
82 | </para></listitem> | 81 | </para></listitem> |
83 | </itemizedlist> | 82 | </itemizedlist> |
83 | Toaster also allows you to configure and run your builds | ||
84 | from the command line, and switch between the command line and | ||
85 | the web interface at any time. | ||
86 | Builds started from the command line appear within a special | ||
87 | Toaster project called "Command line builds". | ||
84 | </para></listitem> | 88 | </para></listitem> |
85 | <listitem><para id='toaster-build-mode'><emphasis>Build Mode:</emphasis> | 89 | <listitem><para id='toaster-analysis-features'> |
86 | In Build Mode, Toaster handles the build configuration, | 90 | <emphasis>Information About the Build Process:</emphasis> |
87 | scheduling and execution. | 91 | Toaster also records extensive information about your builds. |
88 | In this mode, all your interaction with the build system | 92 | Toaster collects data for builds you start from the web |
89 | happens through the web interface. | 93 | interface and from the command line as long as Toaster |
90 | You do not have direct access to the | 94 | is running. |
91 | <filename>bitbake</filename> command.</para> | 95 | <note> |
92 | <para>Using this mode, you configure and start your builds | 96 | You must start Toaster before the build or it will not |
93 | within Toaster's GUI. | 97 | collect build data. |
94 | Each project can be configured for a specific version | 98 | </note></para> |
95 | of the build system. | 99 | <para>With Toaster you can: |
96 | As shipped, Toaster supports Yocto Project Releases 1.7 and | ||
97 | beyond.</para> | ||
98 | <para>Toaster has all the same capabilities in Build Mode | ||
99 | as it does in Analysis Mode plus the following: | ||
100 | <itemizedlist> | 100 | <itemizedlist> |
101 | <listitem><para> | 101 | <listitem><para> |
102 | Browse layers listed in the various | 102 | See what was built (recipes and packages) and what |
103 | <link linkend='layer-source'>layer sources</link> | 103 | packages were installed into your final image. |
104 | that are available in your project (e.g. the | ||
105 | OpenEmbedded Metadata Index at | ||
106 | <ulink url='http://layers.openembedded.org/layerindex/'></ulink>). | ||
107 | </para></listitem> | 104 | </para></listitem> |
108 | <listitem><para> | 105 | <listitem><para> |
109 | Import your own layers for building. | 106 | Browse the directory structure of your image. |
110 | </para></listitem> | 107 | </para></listitem> |
111 | <listitem><para> | 108 | <listitem><para> |
112 | Add and remove layers from your configuration. | 109 | See the value of all variables in your build |
110 | configuration, and which files set each value. | ||
113 | </para></listitem> | 111 | </para></listitem> |
114 | <listitem><para> | 112 | <listitem><para> |
115 | Set configuration variables. | 113 | Examine error, warning, and trace messages to aid |
114 | in debugging. | ||
116 | </para></listitem> | 115 | </para></listitem> |
117 | <listitem><para> | 116 | <listitem><para> |
118 | Select a target or multiple targets to build. | 117 | See information about the BitBake tasks executed |
118 | and reused during your build, including those that | ||
119 | used shared state. | ||
119 | </para></listitem> | 120 | </para></listitem> |
120 | <listitem><para> | 121 | <listitem><para> |
121 | Start your builds. | 122 | See dependency relationships between recipes, |
123 | packages, and tasks. | ||
124 | </para></listitem> | ||
125 | <listitem><para> | ||
126 | See performance information such as build time, | ||
127 | task time, CPU usage, and disk I/O. | ||
122 | </para></listitem> | 128 | </para></listitem> |
123 | </itemizedlist> | 129 | </itemizedlist> |
124 | </para></listitem> | 130 | </para></listitem> |
@@ -132,8 +138,6 @@ | |||
132 | <para> | 138 | <para> |
133 | You can set Toaster up to run as a local instance or as a shared | 139 | You can set Toaster up to run as a local instance or as a shared |
134 | hosted service. | 140 | hosted service. |
135 | Regardless of how you set up Toaster, both Analysis and Build | ||
136 | Modes are available. | ||
137 | </para> | 141 | </para> |
138 | 142 | ||
139 | <para> | 143 | <para> |
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 @@ | |||
159 | </para> | 159 | </para> |
160 | 160 | ||
161 | <para> | 161 | <para> |
162 | When you set up Toaster in Build Mode, you are prompted | 162 | The Toaster startup script in |
163 | to select a Toaster configuration file. | 163 | <filename>/bitbake/bin/toaster</filename> specifies |
164 | the location of a Toaster configuration file | ||
165 | <filename>toasterconf.json</filename> as the value of | ||
166 | the <filename>TOASTER_CONF</filename> variable. | ||
164 | This configuration file is used to set up the initial | 167 | This configuration file is used to set up the initial |
165 | configuration values within the Toaster database | 168 | configuration values within the Toaster database |
166 | including the layer sources. | 169 | including the layer sources. |
167 | Three versions of the configuration file exist: | 170 | Two versions of the configuration file exist: |
168 | <itemizedlist> | 171 | <itemizedlist> |
169 | <listitem><para> | 172 | <listitem><para> |
170 | The first version of the file is found in the | 173 | The first version of the file is found in the |
@@ -192,14 +195,6 @@ | |||
192 | (i.e. | 195 | (i.e. |
193 | <filename>git://git.openembedded.org/openembedded-core</filename>). | 196 | <filename>git://git.openembedded.org/openembedded-core</filename>). |
194 | </para></listitem> | 197 | </para></listitem> |
195 | <listitem><para> | ||
196 | The third version is a sample configuration | ||
197 | useful for when you want to set up a hosted | ||
198 | service in Build Mode. | ||
199 | You can find this version on the | ||
200 | <ulink url='https://wiki.yoctoproject.org/wiki/File:Toasterconf.json.txt.patch'>File:Toasterconf.json.txt.patch</ulink> | ||
201 | wiki page. | ||
202 | </para></listitem> | ||
203 | </itemizedlist> | 198 | </itemizedlist> |
204 | </para> | 199 | </para> |
205 | </section> | 200 | </section> |
@@ -550,8 +545,7 @@ | |||
550 | <title>JSON Files</title> | 545 | <title>JSON Files</title> |
551 | 546 | ||
552 | <para> | 547 | <para> |
553 | If you are going to be using Toaster in Build Mode, it must | 548 | You must configure Toaster before using it. |
554 | be initially configured before use. | ||
555 | Configuration customizes layer source settings and Toaster defaults | 549 | Configuration customizes layer source settings and Toaster defaults |
556 | for all users and is performed by the person responsible for | 550 | for all users and is performed by the person responsible for |
557 | Toaster Configuration (i.e the Toaster Administrator). | 551 | Toaster Configuration (i.e the Toaster Administrator). |
@@ -577,17 +571,16 @@ | |||
577 | <filename>toasterconf.json</filename>. | 571 | <filename>toasterconf.json</filename>. |
578 | The Toaster Administrator can customize the file prior to loading | 572 | The Toaster Administrator can customize the file prior to loading |
579 | it into Toaster. | 573 | it into Toaster. |
580 | When you set up Toaster locally to run in Build Mode, the system | 574 | The <filename>TOASTER_CONF</filename> variable in the |
581 | startup script actively looks for compatible configuration files | 575 | Toaster startup script at <filename>bitbake/bin/toaster</filename> |
582 | and prompts you to select a file to load if it detects that the | 576 | specifies the location of the <filename>toasterconf.json</filename> file. |
583 | database has not been configured. | ||
584 | </para> | 577 | </para> |
585 | 578 | ||
586 | <section id='json-file-choices'> | 579 | <section id='json-file-choices'> |
587 | <title>Configuration File Choices</title> | 580 | <title>Configuration File Choices</title> |
588 | 581 | ||
589 | <para> | 582 | <para> |
590 | Three versions of the configuration file exist: | 583 | Two versions of the configuration file exist: |
591 | <itemizedlist> | 584 | <itemizedlist> |
592 | <listitem><para> | 585 | <listitem><para> |
593 | The | 586 | The |
@@ -613,15 +606,6 @@ | |||
613 | <filename>openembedded-core</filename> repository (i.e. | 606 | <filename>openembedded-core</filename> repository (i.e. |
614 | <filename>git://git.openembedded.org/openembedded-core</filename>). | 607 | <filename>git://git.openembedded.org/openembedded-core</filename>). |
615 | </para></listitem> | 608 | </para></listitem> |
616 | <listitem><para> | ||
617 | The <filename>Toasterconf.json.txt.patch</filename> | ||
618 | located on the | ||
619 | <ulink url='https://wiki.yoctoproject.org/wiki/File:Toasterconf.json.txt.patch'>File:Toasterconf.json.txt.patch</ulink> | ||
620 | wiki page. | ||
621 | This version of the file is useful as a sample | ||
622 | configuration for when you want to set up Toaster as a | ||
623 | hosted service in Build Mode. | ||
624 | </para></listitem> | ||
625 | </itemizedlist> | 609 | </itemizedlist> |
626 | </para> | 610 | </para> |
627 | </section> | 611 | </section> |
@@ -1008,7 +992,7 @@ | |||
1008 | <literallayout class='monospaced'> | 992 | <literallayout class='monospaced'> |
1009 | $ bitbake/lib/toaster/manage.py checksettings | 993 | $ bitbake/lib/toaster/manage.py checksettings |
1010 | </literallayout> | 994 | </literallayout> |
1011 | In Build Mode, Toaster uses settings that are based on the | 995 | Toaster uses settings that are based on the |
1012 | database to configure the building tasks. | 996 | database to configure the building tasks. |
1013 | The <filename>checksettings</filename> command verifies that | 997 | The <filename>checksettings</filename> command verifies that |
1014 | the database settings are valid in the sense that they have | 998 | the database settings are valid in the sense that they have |