toaster-manual: describe the way to start Toaster
PATCH 1/1 toaster-manual: describe the way 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.
Signed-off-by Ed Bartosh <[email protected]>
--- .../toaster-manual-setup-and-use.xml | 67 +++------------------- 1 file changed, 8 insertions(+), 59 deletions(-)
documentation/toaster-manual/toaster-manual-setup-and-use.xml +8 -59
@@ -17,32 +17,12 @@ </para> <para> - If you want to configure and start your builds using the - Toaster web interface - (i.e. "<link linkend='toaster-build-mode'>Build Mode</link>"), - navigate to the root of your + Navigate to the root of your <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> (e.g. <filename>poky</filename>): <literallayout class='monospaced'> $ cd poky </literallayout> - Next, start Toaster: - <literallayout class='monospaced'> - $ bitbake/bin/toaster - </literallayout> - Open your favourite browser and enter the following: - <literallayout class='monospaced'> - http://127.0.0.1:8000 - </literallayout> - If you would rather configure and start your builds - using the command line - (i.e. <link linkend='toaster-analysis-mode'>Analysis Mode</link>), - you can get Toaster to "listen" - to your builds and collect information about them. - To do that, navigate to the root of your Source Directory: - <literallayout class='monospaced'> - $ cd poky - </literallayout> Once in that directory, source the build environment script: <literallayout class='monospaced'> $ source oe-init-build-env
@@ -72,12 +52,7 @@ By default, Toaster starts on port 8000. You can use the <filename>WEBPORT</filename> parameter to set a different port. - For example, either of the following commands sets the - port to "8400": - <literallayout class='monospaced'> - $ bitbake/bin/toaster webport=8400 - </literallayout> - or + For example, the following command sets the port to "8400": <literallayout class='monospaced'> $ source ../bitbake/bin/toaster webport=8400 </literallayout>
@@ -88,18 +63,10 @@ <title>The Directory for Cloning Layers</title> <para> - If you are running Toaster in - <link linkend='toaster-build-mode'>Build Mode</link>, Toaster creates a <filename>_toaster_clones</filename> directory inside your Source Directory - (i.e. <filename>poky</filename>). - For example, suppose you use this command to start Toaster: - <literallayout class='monospaced'> - poky/bitbake/bin/toaster - </literallayout> - In this example, Toaster creates and uses the - <filename>poky/_toaster_clones</filename> - directory to clone any layers needed for your builds. + (i.e. <filename>poky</filename>) to clone any layers + needed for your builds. </para> <para>
@@ -117,17 +84,9 @@ <title>The Build Directory</title> <para> - If you are running Toaster in - <link linkend='toaster-build-mode'>Build Mode</link>, Toaster creates a build directory within your Source - Directory (e.g. <filename>poky</filename>). - For example, suppose you use this command to start Toaster: - <literallayout class='monospaced'> - poky/bitbake/bin/toaster - </literallayout> - In this example, Toaster creates and uses the - <filename>poky/build</filename> - directory to execute the builds. + Directory (e.g. <filename>poky</filename>) to execute + the builds. </para> <para>
@@ -136,7 +95,7 @@ the <filename>TOASTER_DIR</filename> environment variable, which takes precedence over your current working directory. Setting this environment variable causes Toaster to use - <filename>$TOASTER_DIR./build</filename> as the build directory. + <filename>$TOASTER_DIR/build</filename> as the build directory. </para> </section>
@@ -217,10 +176,7 @@ The production instance is also the setup that can cope with heavier loads on the web service. Use the instructions in the following sections to set up - Toaster in - <link linkend='toaster-build-mode'>Build Mode</link> - where builds and projects are run, - viewed, and defined through the Toaster web interface. + Toaster to run builds through the Toaster web interface. </para> <section id='toaster-production-instance-requirements'>
@@ -333,13 +289,6 @@ STATIC_ROOT = '/var/www/toaster/static_files/' </literallayout> </para></listitem> - <listitem><para> - Enable Build Mode by adding the following - line to <filename>settings.py</filename>: - <literallayout class='monospaced'> - BUILD_MODE=True - </literallayout> - </para></listitem> </itemizedlist> </para></listitem> <listitem><para>
Signature · 1 line
2.1.4
Quoted 7 lines · On 10/12/2015 11:49, "[email protected] on behalf of Ed…
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.
I think this looks fine, although the line "You can now run builds normally" is a bit too terse. Maybe we could replace it with something like this:
"You can now run your builds from the command line, or using Toaster as explained in section 3.7. Using the Toaster Web Interface"
"3.7. Using the Toaster Web Interface" should be a link to that section.
We should also replace the paragraph
"To see the build information provided by Toaster, open your favorite browser and enter the following:"
With:
"To access the Toaster web interface, open your favourite browser and enter the following:"
Cheers
Belén
Quoted 150 lines
Signed-off-by Ed Bartosh <[email protected]>---
.../toaster-manual-setup-and-use.xml| 67
+++-------------------1 file changed, 8 insertions(+), 59 deletions(-)(quoted diff) +0
-0
a/documentation/toaster-manual/toaster-manual-setup-and-use.xmlb/documentation/toaster-manual/toaster-manual-setup-and-use.xmlindex 74c00c4..75aaea8 100644documentation/toaster-manual/toaster-manual-setup-and-use.xml +1
-4@@ -17,32 +17,12 @@ </para> <para> - If you want to configure and start your builds using the - Toaster web interface - (i.e. "<link linkend='toaster-build-mode'>Build Mode</link>"), - navigate to the root of your + Navigate to the root of your <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>SourceDirectory</ulink>
(e.g. <filename>poky</filename>):
<literallayout class='monospaced'>
$ cd poky
</literallayout>documentation/toaster-manual/toaster-manual-setup-and-use.xml +0
-11- Next, start Toaster: - <literallayout class='monospaced'> - $ bitbake/bin/toaster - </literallayout> - Open your favourite browser and enter the following: - <literallayout class='monospaced'> - http://127.0.0.1:8000 - </literallayout> - If you would rather configure and start your builds - using the command line - (i.e. <link linkend='toaster-analysis-mode'>AnalysisMode</link>),
documentation/toaster-manual/toaster-manual-setup-and-use.xml +5
-33- you can get Toaster to "listen" - to your builds and collect information about them. - To do that, navigate to the root of your Source Directory: - <literallayout class='monospaced'> - $ cd poky - </literallayout> Once in that directory, source the build environment script: <literallayout class='monospaced'> $ source oe-init-build-env@@ -72,12 +52,7 @@ By default, Toaster starts on port 8000. You can use the <filename>WEBPORT</filename> parameter to set a different port. - For example, either of the following commands sets the - port to "8400": - <literallayout class='monospaced'> - $ bitbake/bin/toaster webport=8400 - </literallayout> - or + For example, the following command sets the port to "8400": <literallayout class='monospaced'> $ source ../bitbake/bin/toaster webport=8400 </literallayout>@@ -88,18 +63,10 @@ <title>The Directory for Cloning Layers</title> <para> - If you are running Toaster in - <link linkend='toaster-build-mode'>Build Mode</link>, Toaster creates a <filename>_toaster_clones</filename> directory inside your Source Directory - (i.e. <filename>poky</filename>). - For example, suppose you use this command to start Toaster: - <literallayout class='monospaced'> - poky/bitbake/bin/toaster - </literallayout> - In this example, Toaster creates and uses the - <filename>poky/_toaster_clones</filename> - directory to clone any layers needed for your builds. + (i.e. <filename>poky</filename>) to clone any layers + needed for your builds. </para> <para>@@ -117,17 +84,9 @@ <title>The Build Directory</title> <para> - If you are running Toaster in - <link linkend='toaster-build-mode'>Build Mode</link>, Toaster creates a build directory within your Source - Directory (e.g. <filename>poky</filename>). - For example, suppose you use this command to start Toaster: - <literallayout class='monospaced'> - poky/bitbake/bin/toaster - </literallayout> - In this example, Toaster creates and uses the - <filename>poky/build</filename> - directory to execute the builds. + Directory (e.g. <filename>poky</filename>) to execute + the builds. </para> <para>@@ -136,7 +95,7 @@ the <filename>TOASTER_DIR</filename> environment variable, which takes precedence over your current working directory. Setting this environment variable causes Toaster to use - <filename>$TOASTER_DIR./build</filename> as the builddirectory.
+ <filename>$TOASTER_DIR/build</filename> as the build
directory.</para> </section>documentation/toaster-manual/toaster-manual-setup-and-use.xml +1
-11@@ -217,10 +176,7 @@ The production instance is also the setup that can cope with heavier loads on the web service. Use the instructions in the following sections to set up - Toaster in - <link linkend='toaster-build-mode'>Build Mode</link> - where builds and projects are run, - viewed, and defined through the Toaster web interface. + Toaster to run builds through the Toaster web interface. </para> <section id='toaster-production-instance-requirements'>@@ -333,13 +289,6 @@ STATIC_ROOT = '/var/www/toaster/static_files/' </literallayout> </para></listitem> - <listitem><para> - Enable Build Mode by adding the following - line to <filename>settings.py</filename>: - <literallayout class='monospaced'> - BUILD_MODE=True - </literallayout> - </para></listitem> </itemizedlist> </para></listitem> <listitem><para>Signature · 7 lines
2.1.4 -- _______________________________________________ toaster mailing list [email protected] https://lists.yoctoproject.org/listinfo/toaster
Quoted 5 lines · Ed Bartosh
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.
Submitted to [email protected] and to toaster-next.
Elliot
Quoted 152 lines
Updated instructions to start toaster according to the changes described above.
Signed-off-by Ed Bartosh <[email protected]>--- .../toaster-manual-setup-and-use.xml | 67 +++------------------- 1 file changed, 8 insertions(+), 59 deletions(-)documentation/toaster-manual/toaster-manual-setup-and-use.xml +1
-4@@ -17,32 +17,12 @@ </para> <para> - If you want to configure and start your builds using the - Toaster web interface - (i.e. "<link linkend='toaster-build-mode'>Build Mode</link>"), - navigate to the root of your + Navigate to the root of your <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>SourceDirectory</ulink>
(e.g. <filename>poky</filename>):
<literallayout class='monospaced'>
$ cd poky
</literallayout>documentation/toaster-manual/toaster-manual-setup-and-use.xml +0
-11- Next, start Toaster: - <literallayout class='monospaced'> - $ bitbake/bin/toaster - </literallayout> - Open your favourite browser and enter the following: - <literallayout class='monospaced'> - http://127.0.0.1:8000 - </literallayout> - If you would rather configure and start your builds - using the command line - (i.e. <link linkend='toaster-analysis-mode'>AnalysisMode</link>),
documentation/toaster-manual/toaster-manual-setup-and-use.xml +5
-33- you can get Toaster to "listen" - to your builds and collect information about them. - To do that, navigate to the root of your Source Directory: - <literallayout class='monospaced'> - $ cd poky - </literallayout> Once in that directory, source the build environment script: <literallayout class='monospaced'> $ source oe-init-build-env@@ -72,12 +52,7 @@ By default, Toaster starts on port 8000. You can use the <filename>WEBPORT</filename> parameter to set a different port. - For example, either of the following commands sets the - port to "8400": - <literallayout class='monospaced'> - $ bitbake/bin/toaster webport=8400 - </literallayout> - or + For example, the following command sets the port to "8400": <literallayout class='monospaced'> $ source ../bitbake/bin/toaster webport=8400 </literallayout>@@ -88,18 +63,10 @@ <title>The Directory for Cloning Layers</title> <para> - If you are running Toaster in - <link linkend='toaster-build-mode'>Build Mode</link>, Toaster creates a <filename>_toaster_clones</filename> directory inside your Source Directory - (i.e. <filename>poky</filename>). - For example, suppose you use this command to start Toaster: - <literallayout class='monospaced'> - poky/bitbake/bin/toaster - </literallayout> - In this example, Toaster creates and uses the - <filename>poky/_toaster_clones</filename> - directory to clone any layers needed for your builds. + (i.e. <filename>poky</filename>) to clone any layers + needed for your builds. </para> <para>@@ -117,17 +84,9 @@ <title>The Build Directory</title> <para> - If you are running Toaster in - <link linkend='toaster-build-mode'>Build Mode</link>, Toaster creates a build directory within your Source - Directory (e.g. <filename>poky</filename>). - For example, suppose you use this command to start Toaster: - <literallayout class='monospaced'> - poky/bitbake/bin/toaster - </literallayout> - In this example, Toaster creates and uses the - <filename>poky/build</filename> - directory to execute the builds. + Directory (e.g. <filename>poky</filename>) to execute + the builds. </para> <para>@@ -136,7 +95,7 @@ the <filename>TOASTER_DIR</filename> environment variable, which takes precedence over your current working directory. Setting this environment variable causes Toaster to use - <filename>$TOASTER_DIR./build</filename> as the builddirectory.
+ <filename>$TOASTER_DIR/build</filename> as the build
directory.</para> </section>documentation/toaster-manual/toaster-manual-setup-and-use.xml +1
-12@@ -217,10 +176,7 @@ The production instance is also the setup that can cope with heavier loads on the web service. Use the instructions in the following sections to set up - Toaster in - <link linkend='toaster-build-mode'>Build Mode</link> - where builds and projects are run, - viewed, and defined through the Toaster web interface. + Toaster to run builds through the Toaster web interface. </para> <section id='toaster-production-instance-requirements'>@@ -333,13 +289,6 @@ STATIC_ROOT = '/var/www/toaster/static_files/' </literallayout> </para></listitem> - <listitem><para> - Enable Build Mode by adding the following - line to <filename>settings.py</filename>: - <literallayout class='monospaced'> - BUILD_MODE=True - </literallayout> - </para></listitem> </itemizedlist> </para></listitem> <listitem><para> --2.1.4
--
_______________________________________________
toaster mailing list
[email protected]
https://lists.yoctoproject.org/listinfo/toaster
Signature · 3 lines
Elliot Smith Software Engineer Intel Open Source Technology Centre