From c636c224845578fb12be1295f644face32a29810 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Wed, 1 Apr 2015 08:32:22 -0700 Subject: dev-manual: Added a small section to note Toaster as a development model. (From yocto-docs rev: 63e73beca3b7d084c4776f296d3310a31dafcfc4) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- .../dev-manual/dev-manual-common-tasks.xml | 211 --------------------- 1 file changed, 211 deletions(-) (limited to 'documentation') 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 @@ -
- Examining Builds Using the Toaster API - - - Toaster is an Application Programming Interface (API) and - web-based interface to the OpenEmbedded build system, which uses - BitBake. - Both interfaces are based on a Representational State Transfer - (REST) API that queries for and returns build information using - GET and JSON. - These types of search operations retrieve sets of objects from - a datastore used to collect build information. - The results contain all the data for the objects being returned. - You can order the results of the search by key and the search - parameters are consistent for all object types. - - - - Using the interfaces you can do the following: - - See information about the tasks executed - and reused during the build. - See what is built (recipes and - packages) and what packages were installed into the final - image. - See performance-related information such - as build time, CPU usage, and disk I/O. - Examine error, warning and trace messages - to aid in debugging. - - - - - This release of Toaster provides you with information - about a BitBake run. - The tool does not allow you to configure and launch a build. - However, future development includes plans to integrate the - configuration and build launching capabilities of - Hob. - - For more information on using Hob to build an image, - see the - "Image Development Using Hob" - section. - - - - The remainder of this section describes what you need to have in - place to use Toaster, how to start it, use it, and stop it. - For additional information on installing and running Toaster, see the - "Installation and Running" - section of the "Toaster" wiki page. - For complete information on the API and its search operation - URI, parameters, and responses, see the - REST API Contracts - Wiki page. - - -
- Starting Toaster - - - Getting set up to use and start Toaster is simple. - First, be sure you have met the following requirements: - - You have set up your - Source Directory - by cloning the upstream poky - repository. - See the - Yocto Project Release - item for information on how to set up the Source - Directory. - Be sure your build machine has - Django - version 1.5 installed. - Make sure that port 8000 and 8200 are - free (i.e. they have no servers on them). - - - - - - Once you have met the requirements, follow these steps to - start Toaster running in the background of your shell: - - Set up your build environment: - Source a build environment script (i.e. - &OE_INIT_FILE; - or - oe-init-build-env-memres). - - Start Toaster: - Start the Toaster service using this - command from within your - Build Directory: - - $ source toaster start - - - The Toaster must be started and running in order - for it to collect data. - - - - - - When Toaster starts, it creates some additional files in your - Build Directory. - Deleting these files will cause you to lose data or interrupt - Toaster: - - toaster.sqlite: - Toaster's database file. - toaster_web.log: - The log file of the web server. - toaster_ui.log: - The log file of the user interface component. - - toastermain.pid: - The PID of the web server. - toasterui.pid: - The PID of the DSI data bridge. - bitbake-cookerdaemon.log: - The BitBake server's log file. - - -
- -
- Using Toaster - - - Once Toaster is running, it logs information for any BitBake - run from your Build Directory. - This logging is automatic. - All you need to do is access and use the information. - - - - You access the information one of two ways: - - Open a Browser and enter - http://localhost:8000 - for the URL. - - Use the xdg-open - tool from the shell and pass it the same URL. - - - Either method opens the home page for the Toaster interface. - - - Notes - - - For information on how to delete information from the - Toaster database, see the - Deleting a Build from the Toaster Database - wiki page. - - - For information on how to set up an instance of Toaster - on a remote host, see the - Setting Up a Toaster Instance on a Remote Host - wiki page. - - - -
- -
- Examining Toaster Data - - - The Toaster database is persistent regardless of whether you - start or stop the service. - - - - Toaster's interface shows you a list of builds - (successful and unsuccessful) for which it has data. - You can click on any build to see related information. - This information includes configuration details, information - about tasks, all recipes and packages built and their - dependencies, packages and their directory structure as - installed in your final image, - execution time, CPU usage and disk I/O per task. - - - - For details on the interface, see the - Toaster Manual. - -
- -
- Stopping Toaster - - - Stop the Toaster service with the following command - from with the - Build Directory: - - $ source toaster stop - - The service stops but the Toaster database remains persistent. - -
-
-
Profiling with OProfile -- cgit v1.2.3-54-g00ecf