diff options
| author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2015-04-01 08:32:22 -0700 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2015-04-01 17:35:33 +0100 |
| commit | 3bb1c7676196f6e88a6d587ee75847a37486d225 (patch) | |
| tree | 7ac433c590d7b71449752031c17b85cc5a03e0f7 /documentation/dev-manual | |
| parent | 3237e33c087b206d3b387f5a4953c14a75e7d1d4 (diff) | |
| download | poky-3bb1c7676196f6e88a6d587ee75847a37486d225.tar.gz | |
dev-manual: Added a small section to note Toaster as a development model.
(From yocto-docs rev: 63e73beca3b7d084c4776f296d3310a31dafcfc4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual')
| -rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 211 |
1 files changed, 0 insertions, 211 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index b35dc2f0a9..c856775303 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml | |||
| @@ -9336,217 +9336,6 @@ | |||
| 9336 | </section> | 9336 | </section> |
| 9337 | </section> | 9337 | </section> |
| 9338 | 9338 | ||
| 9339 | <section id="examining-builds-using-toaster"> | ||
| 9340 | <title>Examining Builds Using the Toaster API</title> | ||
| 9341 | |||
| 9342 | <para> | ||
| 9343 | Toaster is an Application Programming Interface (API) and | ||
| 9344 | web-based interface to the OpenEmbedded build system, which uses | ||
| 9345 | BitBake. | ||
| 9346 | Both interfaces are based on a Representational State Transfer | ||
| 9347 | (REST) API that queries for and returns build information using | ||
| 9348 | <filename>GET</filename> and <filename>JSON</filename>. | ||
| 9349 | These types of search operations retrieve sets of objects from | ||
| 9350 | a datastore used to collect build information. | ||
| 9351 | The results contain all the data for the objects being returned. | ||
| 9352 | You can order the results of the search by key and the search | ||
| 9353 | parameters are consistent for all object types. | ||
| 9354 | </para> | ||
| 9355 | |||
| 9356 | <para> | ||
| 9357 | Using the interfaces you can do the following: | ||
| 9358 | <itemizedlist> | ||
| 9359 | <listitem><para>See information about the tasks executed | ||
| 9360 | and reused during the build.</para></listitem> | ||
| 9361 | <listitem><para>See what is built (recipes and | ||
| 9362 | packages) and what packages were installed into the final | ||
| 9363 | image.</para></listitem> | ||
| 9364 | <listitem><para>See performance-related information such | ||
| 9365 | as build time, CPU usage, and disk I/O.</para></listitem> | ||
| 9366 | <listitem><para>Examine error, warning and trace messages | ||
| 9367 | to aid in debugging.</para></listitem> | ||
| 9368 | </itemizedlist> | ||
| 9369 | </para> | ||
| 9370 | |||
| 9371 | <note> | ||
| 9372 | <para>This release of Toaster provides you with information | ||
| 9373 | about a BitBake run. | ||
| 9374 | The tool does not allow you to configure and launch a build. | ||
| 9375 | However, future development includes plans to integrate the | ||
| 9376 | configuration and build launching capabilities of | ||
| 9377 | <ulink url='&YOCTO_HOME_URL;/tools-resources/projects/hob'>Hob</ulink>. | ||
| 9378 | </para> | ||
| 9379 | <para>For more information on using Hob to build an image, | ||
| 9380 | see the | ||
| 9381 | "<link linkend='image-development-using-hob'>Image Development Using Hob</link>" | ||
| 9382 | section.</para> | ||
| 9383 | </note> | ||
| 9384 | |||
| 9385 | <para> | ||
| 9386 | The remainder of this section describes what you need to have in | ||
| 9387 | place to use Toaster, how to start it, use it, and stop it. | ||
| 9388 | For additional information on installing and running Toaster, see the | ||
| 9389 | "<ulink url='https://wiki.yoctoproject.org/wiki/Toaster#Installation_and_Running'>Installation and Running</ulink>" | ||
| 9390 | section of the "Toaster" wiki page. | ||
| 9391 | For complete information on the API and its search operation | ||
| 9392 | URI, parameters, and responses, see the | ||
| 9393 | <ulink url='https://wiki.yoctoproject.org/wiki/REST_API_Contracts'>REST API Contracts</ulink> | ||
| 9394 | Wiki page. | ||
| 9395 | </para> | ||
| 9396 | |||
| 9397 | <section id='starting-toaster'> | ||
| 9398 | <title>Starting Toaster</title> | ||
| 9399 | |||
| 9400 | <para> | ||
| 9401 | Getting set up to use and start Toaster is simple. | ||
| 9402 | First, be sure you have met the following requirements: | ||
| 9403 | <itemizedlist> | ||
| 9404 | <listitem><para>You have set up your | ||
| 9405 | <link linkend='source-directory'>Source Directory</link> | ||
| 9406 | by cloning the upstream <filename>poky</filename> | ||
| 9407 | repository. | ||
| 9408 | See the | ||
| 9409 | <link linkend='local-yp-release'>Yocto Project Release</link> | ||
| 9410 | item for information on how to set up the Source | ||
| 9411 | Directory.</para></listitem> | ||
| 9412 | <listitem><para>Be sure your build machine has | ||
| 9413 | <ulink url='http://en.wikipedia.org/wiki/Django_%28web_framework%29'>Django</ulink> | ||
| 9414 | version 1.5 installed.</para></listitem> | ||
| 9415 | <listitem><para>Make sure that port 8000 and 8200 are | ||
| 9416 | free (i.e. they have no servers on them). | ||
| 9417 | </para></listitem> | ||
| 9418 | </itemizedlist> | ||
| 9419 | </para> | ||
| 9420 | |||
| 9421 | <para> | ||
| 9422 | Once you have met the requirements, follow these steps to | ||
| 9423 | start Toaster running in the background of your shell: | ||
| 9424 | <orderedlist> | ||
| 9425 | <listitem><para><emphasis>Set up your build environment:</emphasis> | ||
| 9426 | Source a build environment script (i.e. | ||
| 9427 | <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink> | ||
| 9428 | or | ||
| 9429 | <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>). | ||
| 9430 | </para></listitem> | ||
| 9431 | <listitem><para><emphasis>Start Toaster:</emphasis> | ||
| 9432 | Start the Toaster service using this | ||
| 9433 | command from within your | ||
| 9434 | <link linkend='build-directory'>Build Directory</link>: | ||
| 9435 | <literallayout class='monospaced'> | ||
| 9436 | $ source toaster start | ||
| 9437 | </literallayout></para></listitem> | ||
| 9438 | <note> | ||
| 9439 | The Toaster must be started and running in order | ||
| 9440 | for it to collect data. | ||
| 9441 | </note> | ||
| 9442 | </orderedlist> | ||
| 9443 | </para> | ||
| 9444 | |||
| 9445 | <para> | ||
| 9446 | When Toaster starts, it creates some additional files in your | ||
| 9447 | Build Directory. | ||
| 9448 | Deleting these files will cause you to lose data or interrupt | ||
| 9449 | Toaster: | ||
| 9450 | <itemizedlist> | ||
| 9451 | <listitem><para><emphasis><filename>toaster.sqlite</filename>:</emphasis> | ||
| 9452 | Toaster's database file.</para></listitem> | ||
| 9453 | <listitem><para><emphasis><filename>toaster_web.log</filename>:</emphasis> | ||
| 9454 | The log file of the web server.</para></listitem> | ||
| 9455 | <listitem><para><emphasis><filename>toaster_ui.log</filename>:</emphasis> | ||
| 9456 | The log file of the user interface component. | ||
| 9457 | </para></listitem> | ||
| 9458 | <listitem><para><emphasis><filename>toastermain.pid</filename>:</emphasis> | ||
| 9459 | The PID of the web server.</para></listitem> | ||
| 9460 | <listitem><para><emphasis><filename>toasterui.pid</filename>:</emphasis> | ||
| 9461 | The PID of the DSI data bridge.</para></listitem> | ||
| 9462 | <listitem><para><emphasis><filename>bitbake-cookerdaemon.log</filename>:</emphasis> | ||
| 9463 | The BitBake server's log file.</para></listitem> | ||
| 9464 | </itemizedlist> | ||
| 9465 | </para> | ||
| 9466 | </section> | ||
| 9467 | |||
| 9468 | <section id='using-toaster'> | ||
| 9469 | <title>Using Toaster</title> | ||
| 9470 | |||
| 9471 | <para> | ||
| 9472 | Once Toaster is running, it logs information for any BitBake | ||
| 9473 | run from your Build Directory. | ||
| 9474 | This logging is automatic. | ||
| 9475 | All you need to do is access and use the information. | ||
| 9476 | </para> | ||
| 9477 | |||
| 9478 | <para> | ||
| 9479 | You access the information one of two ways: | ||
| 9480 | <itemizedlist> | ||
| 9481 | <listitem><para>Open a Browser and enter | ||
| 9482 | <filename>http://localhost:8000</filename> | ||
| 9483 | for the URL. | ||
| 9484 | </para></listitem> | ||
| 9485 | <listitem><para>Use the <filename>xdg-open</filename> | ||
| 9486 | tool from the shell and pass it the same URL. | ||
| 9487 | </para></listitem> | ||
| 9488 | </itemizedlist> | ||
| 9489 | Either method opens the home page for the Toaster interface. | ||
| 9490 | </para> | ||
| 9491 | |||
| 9492 | <note><title>Notes</title> | ||
| 9493 | <itemizedlist> | ||
| 9494 | <listitem><para> | ||
| 9495 | For information on how to delete information from the | ||
| 9496 | Toaster database, see the | ||
| 9497 | <ulink url='https://wiki.yoctoproject.org/wiki/Toaster#Deleting_a_Build_from_the_Toaster_Database'>Deleting a Build from the Toaster Database</ulink> | ||
| 9498 | wiki page. | ||
| 9499 | </para></listitem> | ||
| 9500 | <listitem><para> | ||
| 9501 | For information on how to set up an instance of Toaster | ||
| 9502 | on a remote host, see the | ||
| 9503 | <ulink url='https://wiki.yoctoproject.org/wiki/Toaster#Setting_up_a_Toaster_Instance_on_a_Remote_Host'>Setting Up a Toaster Instance on a Remote Host</ulink> | ||
| 9504 | wiki page. | ||
| 9505 | </para></listitem> | ||
| 9506 | </itemizedlist> | ||
| 9507 | </note> | ||
| 9508 | </section> | ||
| 9509 | |||
| 9510 | <section id='examining-toaster-data'> | ||
| 9511 | <title>Examining Toaster Data</title> | ||
| 9512 | |||
| 9513 | <para> | ||
| 9514 | The Toaster database is persistent regardless of whether you | ||
| 9515 | start or stop the service. | ||
| 9516 | </para> | ||
| 9517 | |||
| 9518 | <para> | ||
| 9519 | Toaster's interface shows you a list of builds | ||
| 9520 | (successful and unsuccessful) for which it has data. | ||
| 9521 | You can click on any build to see related information. | ||
| 9522 | This information includes configuration details, information | ||
| 9523 | about tasks, all recipes and packages built and their | ||
| 9524 | dependencies, packages and their directory structure as | ||
| 9525 | installed in your final image, | ||
| 9526 | execution time, CPU usage and disk I/O per task. | ||
| 9527 | </para> | ||
| 9528 | |||
| 9529 | <para> | ||
| 9530 | For details on the interface, see the | ||
| 9531 | <ulink url='https://www.yoctoproject.org/documentation/toaster-manual'>Toaster Manual</ulink>. | ||
| 9532 | </para> | ||
| 9533 | </section> | ||
| 9534 | |||
| 9535 | <section id='stopping-toaster'> | ||
| 9536 | <title>Stopping Toaster</title> | ||
| 9537 | |||
| 9538 | <para> | ||
| 9539 | Stop the Toaster service with the following command | ||
| 9540 | from with the | ||
| 9541 | <link linkend='build-directory'>Build Directory</link>: | ||
| 9542 | <literallayout class='monospaced'> | ||
| 9543 | $ source toaster stop | ||
| 9544 | </literallayout> | ||
| 9545 | The service stops but the Toaster database remains persistent. | ||
| 9546 | </para> | ||
| 9547 | </section> | ||
| 9548 | </section> | ||
| 9549 | |||
| 9550 | <section id="platdev-oprofile"> | 9339 | <section id="platdev-oprofile"> |
| 9551 | <title>Profiling with OProfile</title> | 9340 | <title>Profiling with OProfile</title> |
| 9552 | 9341 | ||
