summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml57
1 files changed, 41 insertions, 16 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 7a5a375c0e..a4b1c824dc 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -5275,9 +5275,8 @@
5275 <para>This release of Toaster provides you with information 5275 <para>This release of Toaster provides you with information
5276 about a BitBake run. 5276 about a BitBake run.
5277 The tool does not allow you to configure and launch a build. 5277 The tool does not allow you to configure and launch a build.
5278 Future development includes plans to integrate the data examination 5278 However, future development includes plans to integrate the
5279 features of Toaster with the configuration and build launching 5279 configuration and build launching capabilities of
5280 capabilities of
5281 <ulink url='&YOCTO_HOME_URL;/tools-resources/projects/hob'>Hob</ulink>. 5280 <ulink url='&YOCTO_HOME_URL;/tools-resources/projects/hob'>Hob</ulink>.
5282 </para> 5281 </para>
5283 <para>For more information on using Hob to build an image, 5282 <para>For more information on using Hob to build an image,
@@ -5294,14 +5293,19 @@
5294 First, be sure you have met the following requirements: 5293 First, be sure you have met the following requirements:
5295 <itemizedlist> 5294 <itemizedlist>
5296 <listitem><para>You have set up your 5295 <listitem><para>You have set up your
5297 <link linkend='source-directory'>Source Directory</link>. 5296 <link linkend='source-directory'>Source Directory</link>
5297 by cloning the upstream <filename>poky</filename>
5298 repository.
5298 See the 5299 See the
5299 <link linkend='local-yp-release'>Yocto Project Release</link> 5300 <link linkend='local-yp-release'>Yocto Project Release</link>
5300 item for information on how to set up the Source 5301 item for information on how to set up the Source
5301 Directory.</para></listitem> 5302 Directory.</para></listitem>
5302 <listitem><para>Be sure your build machine has 5303 <listitem><para>Be sure your build machine has
5303 <ulink url='http://en.wikipedia.org/wiki/Django_%28web_framework%29'>Django</ulink> 5304 <ulink url='http://en.wikipedia.org/wiki/Django_%28web_framework%29'>Django</ulink>
5304 version 1.4 or greater installed.</para></listitem> 5305 version 1.4.5 or greater installed.</para></listitem>
5306 <listitem><para>Make sure that port 8000 and 8200 are
5307 free (i.e. they have no servers on them).
5308 </para></listitem>
5305 </itemizedlist> 5309 </itemizedlist>
5306 </para> 5310 </para>
5307 5311
@@ -5309,12 +5313,30 @@
5309 Once you have met the requirements, follow these steps to 5313 Once you have met the requirements, follow these steps to
5310 start Toaster running in the background of your shell: 5314 start Toaster running in the background of your shell:
5311 <orderedlist> 5315 <orderedlist>
5312 <listitem><para>Set up your build environment by sourcing 5316 <listitem><para><emphasis>Set up your build environment:</emphasis>
5313 the <filename>oe-init-build-env</filename> script. 5317 Source a build environment script (i.e.
5318 <filename>oe-init-build-env</filename> or
5319 <filename>oe-init-build-env-memres</filename>).
5314 </para></listitem> 5320 </para></listitem>
5315 <listitem><para>Edit your <filename>local.conf</filename> 5321 <listitem><para><emphasis>Prepare your local configuration file:</emphasis>
5316 configuration file as needed.</para></listitem> 5322 Toaster needs the Toaster class enabled
5317 <listitem><para>Start the Toaster service using this 5323 in Bitbake in order to record target image package
5324 information.
5325 You can enable it by adding the following line to your
5326 <filename>conf/local.conf</filename> file:
5327 <literallayout class='monospaced'>
5328 INHERIT += "toaster"
5329 </literallayout>
5330 Toaster also needs Build History enabled in Bitbake in
5331 order to record target image package information.
5332 You can enable this by adding the following two lines
5333 to your <filename>conf/local.conf</filename> file:
5334 <literallayout class='monospaced'>
5335 INHERIT += "buildhistory"
5336 BUILDHISTORY_COMMIT = "1"
5337 </literallayout></para></listitem>
5338 <listitem><para><emphasis>Start Toaster:</emphasis>
5339 Start the Toaster service using this
5318 command from within your build directory: 5340 command from within your build directory:
5319 <literallayout class='monospaced'> 5341 <literallayout class='monospaced'>
5320 $ source toaster start 5342 $ source toaster start
@@ -5334,12 +5356,15 @@
5334 <itemizedlist> 5356 <itemizedlist>
5335 <listitem><para><emphasis><filename>toaster.sqlite</filename>:</emphasis> 5357 <listitem><para><emphasis><filename>toaster.sqlite</filename>:</emphasis>
5336 Toaster's database file.</para></listitem> 5358 Toaster's database file.</para></listitem>
5337 <listitem><para><emphasis><filename>tstmain.log</filename>:</emphasis> 5359 <listitem><para><emphasis><filename>toaster_web.log</filename>:</emphasis>
5338 Toaster's log file.</para></listitem> 5360 The log file of the web server.</para></listitem>
5339 <listitem><para><emphasis><filename>tstmain.pid</filename>:</emphasis> 5361 <listitem><para><emphasis><filename>toaster_ui.log</filename>:</emphasis>
5340 Contains the PID of the web server.</para></listitem> 5362 The log file of the user interface component.
5341 <listitem><para><emphasis><filename>dsi.pid</filename>:</emphasis> 5363 </para></listitem>
5342 Contains the PID of th bridge.</para></listitem> 5364 <listitem><para><emphasis><filename>toastermain.pid</filename>:</emphasis>
5365 The PID of the web server.</para></listitem>
5366 <listitem><para><emphasis><filename>toasterui.pid</filename>:</emphasis>
5367 The PID of the DSI data bridge.</para></listitem>
5343 <listitem><para><emphasis><filename>bitbake-cookerdaemon.log</filename>:</emphasis> 5368 <listitem><para><emphasis><filename>bitbake-cookerdaemon.log</filename>:</emphasis>
5344 The BitBake server's log file.</para></listitem> 5369 The BitBake server's log file.</para></listitem>
5345 </itemizedlist> 5370 </itemizedlist>