diff options
author | Ed Bartosh <ed.bartosh at linux.intel.com> | 2016-01-07 13:14:32 -0600 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2016-01-15 16:31:16 +0000 |
commit | bf81969bbc87223f2ababa20f41f6d2f05dffcca (patch) | |
tree | cde2d181f555a267adb1abd96aa7fe434d3cc960 /documentation | |
parent | 798e8b8d03b78929a936c6ea01166209a747ca1f (diff) | |
download | poky-bf81969bbc87223f2ababa20f41f6d2f05dffcca.tar.gz |
toaster-manual: Updates on how to start Toaster.
Recently, the way to start Toaster has been simplified.
The only way to start it now is to source toaster script.
Builds can be run either from command line or from Toaster
web interface.
Updated instructions to start toaster according to the
changes described above.
(From yocto-docs rev: 2e980c9157abad073e7d08309a99cb2f515441c0)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/toaster-manual/toaster-manual-setup-and-use.xml | 67 |
1 files changed, 8 insertions, 59 deletions
diff --git a/documentation/toaster-manual/toaster-manual-setup-and-use.xml b/documentation/toaster-manual/toaster-manual-setup-and-use.xml index 8c7ff7bd0a..6a69706df2 100644 --- a/documentation/toaster-manual/toaster-manual-setup-and-use.xml +++ b/documentation/toaster-manual/toaster-manual-setup-and-use.xml | |||
@@ -17,32 +17,12 @@ | |||
17 | </para> | 17 | </para> |
18 | 18 | ||
19 | <para> | 19 | <para> |
20 | If you want to configure and start your builds using the | 20 | Navigate to the root of your |
21 | Toaster web interface | ||
22 | (i.e. "<link linkend='toaster-build-mode'>Build Mode</link>"), | ||
23 | navigate to the root of your | ||
24 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> | 21 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> |
25 | (e.g. <filename>poky</filename>): | 22 | (e.g. <filename>poky</filename>): |
26 | <literallayout class='monospaced'> | 23 | <literallayout class='monospaced'> |
27 | $ cd poky | 24 | $ cd poky |
28 | </literallayout> | 25 | </literallayout> |
29 | Next, start Toaster: | ||
30 | <literallayout class='monospaced'> | ||
31 | $ bitbake/bin/toaster | ||
32 | </literallayout> | ||
33 | Open your favourite browser and enter the following: | ||
34 | <literallayout class='monospaced'> | ||
35 | http://127.0.0.1:8000 | ||
36 | </literallayout> | ||
37 | If you would rather configure and start your builds | ||
38 | using the command line | ||
39 | (i.e. <link linkend='toaster-analysis-mode'>Analysis Mode</link>), | ||
40 | you can get Toaster to "listen" | ||
41 | to your builds and collect information about them. | ||
42 | To do that, navigate to the root of your Source Directory: | ||
43 | <literallayout class='monospaced'> | ||
44 | $ cd poky | ||
45 | </literallayout> | ||
46 | Once in that directory, source the build environment script: | 26 | Once in that directory, source the build environment script: |
47 | <literallayout class='monospaced'> | 27 | <literallayout class='monospaced'> |
48 | $ source oe-init-build-env | 28 | $ source oe-init-build-env |
@@ -74,12 +54,7 @@ | |||
74 | By default, Toaster starts on port 8000. | 54 | By default, Toaster starts on port 8000. |
75 | You can use the <filename>WEBPORT</filename> parameter to | 55 | You can use the <filename>WEBPORT</filename> parameter to |
76 | set a different port. | 56 | set a different port. |
77 | For example, either of the following commands sets the | 57 | For example, the following command sets the port to "8400": |
78 | port to "8400": | ||
79 | <literallayout class='monospaced'> | ||
80 | $ bitbake/bin/toaster webport=8400 | ||
81 | </literallayout> | ||
82 | or | ||
83 | <literallayout class='monospaced'> | 58 | <literallayout class='monospaced'> |
84 | $ source ../bitbake/bin/toaster webport=8400 | 59 | $ source ../bitbake/bin/toaster webport=8400 |
85 | </literallayout> | 60 | </literallayout> |
@@ -90,18 +65,10 @@ | |||
90 | <title>The Directory for Cloning Layers</title> | 65 | <title>The Directory for Cloning Layers</title> |
91 | 66 | ||
92 | <para> | 67 | <para> |
93 | If you are running Toaster in | ||
94 | <link linkend='toaster-build-mode'>Build Mode</link>, | ||
95 | Toaster creates a <filename>_toaster_clones</filename> | 68 | Toaster creates a <filename>_toaster_clones</filename> |
96 | directory inside your Source Directory | 69 | directory inside your Source Directory |
97 | (i.e. <filename>poky</filename>). | 70 | (i.e. <filename>poky</filename>) to clone any layers |
98 | For example, suppose you use this command to start Toaster: | 71 | needed for your builds. |
99 | <literallayout class='monospaced'> | ||
100 | poky/bitbake/bin/toaster | ||
101 | </literallayout> | ||
102 | In this example, Toaster creates and uses the | ||
103 | <filename>poky/_toaster_clones</filename> | ||
104 | directory to clone any layers needed for your builds. | ||
105 | </para> | 72 | </para> |
106 | 73 | ||
107 | <para> | 74 | <para> |
@@ -119,17 +86,9 @@ | |||
119 | <title>The Build Directory</title> | 86 | <title>The Build Directory</title> |
120 | 87 | ||
121 | <para> | 88 | <para> |
122 | If you are running Toaster in | ||
123 | <link linkend='toaster-build-mode'>Build Mode</link>, | ||
124 | Toaster creates a build directory within your Source | 89 | Toaster creates a build directory within your Source |
125 | Directory (e.g. <filename>poky</filename>). | 90 | Directory (e.g. <filename>poky</filename>) to execute |
126 | For example, suppose you use this command to start Toaster: | 91 | the builds. |
127 | <literallayout class='monospaced'> | ||
128 | poky/bitbake/bin/toaster | ||
129 | </literallayout> | ||
130 | In this example, Toaster creates and uses the | ||
131 | <filename>poky/build</filename> | ||
132 | directory to execute the builds. | ||
133 | </para> | 92 | </para> |
134 | 93 | ||
135 | <para> | 94 | <para> |
@@ -138,7 +97,7 @@ | |||
138 | the <filename>TOASTER_DIR</filename> environment variable, | 97 | the <filename>TOASTER_DIR</filename> environment variable, |
139 | which takes precedence over your current working directory. | 98 | which takes precedence over your current working directory. |
140 | Setting this environment variable causes Toaster to use | 99 | Setting this environment variable causes Toaster to use |
141 | <filename>$TOASTER_DIR./build</filename> as the build directory. | 100 | <filename>$TOASTER_DIR/build</filename> as the build directory. |
142 | </para> | 101 | </para> |
143 | </section> | 102 | </section> |
144 | 103 | ||
@@ -219,10 +178,7 @@ | |||
219 | The production instance is also the setup that can cope with | 178 | The production instance is also the setup that can cope with |
220 | heavier loads on the web service. | 179 | heavier loads on the web service. |
221 | Use the instructions in the following sections to set up | 180 | Use the instructions in the following sections to set up |
222 | Toaster in | 181 | Toaster to run builds through the Toaster web interface. |
223 | <link linkend='toaster-build-mode'>Build Mode</link> | ||
224 | where builds and projects are run, | ||
225 | viewed, and defined through the Toaster web interface. | ||
226 | </para> | 182 | </para> |
227 | 183 | ||
228 | <section id='toaster-production-instance-requirements'> | 184 | <section id='toaster-production-instance-requirements'> |
@@ -335,13 +291,6 @@ | |||
335 | STATIC_ROOT = '/var/www/toaster/static_files/' | 291 | STATIC_ROOT = '/var/www/toaster/static_files/' |
336 | </literallayout> | 292 | </literallayout> |
337 | </para></listitem> | 293 | </para></listitem> |
338 | <listitem><para> | ||
339 | Enable Build Mode by adding the following | ||
340 | line to <filename>settings.py</filename>: | ||
341 | <literallayout class='monospaced'> | ||
342 | BUILD_MODE=True | ||
343 | </literallayout> | ||
344 | </para></listitem> | ||
345 | </itemizedlist> | 294 | </itemizedlist> |
346 | </para></listitem> | 295 | </para></listitem> |
347 | <listitem><para> | 296 | <listitem><para> |