%poky; ] > Introduction 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. You can use Toaster in several different modes: Interactive Mode: In this mode, you can record builds and statistics. In Interactive Mode, you have direct access to the bitbake command, which you use to build images. Managed Mode: In this mode, Toaster handles the build configuration GUI (through Project pages) and build scheduling and execution. Additionally, in addition to these features, builds are triggered through the web interface. You do not have direct access to the bitbake command. Managed Mode also works two separate ways: Local Managed Mode and Remote Managed Mode. Local Managed Mode is the out-of-box mode available once you checkout poky and allows you to perform builds on your local machine. Remote Managed Mode, also known as Hosted Toaster, is a production setup best for organizations supporting multiple users and for organizations using customized Toaster installations. 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 in the Yocto Project Development Manual. The remainder of this manual 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.
Manual development notes: Need chapter on getting your system ready for Toaster and installing Toaster. Probably should consider some past releases of YP in here one way or another. Need a chapter on configuring Toaster. Need a chapter on setting up instances of Toaster. We will want two sub-sections here: 1) a local instance, and 2) a production instance. Need a chapter on starting and stopping Toaster. Need to cover starting in managed mode here. We need a chapter on the user interface. Need to decide if we want to stick with the slick videos that currently live on the YP site. Pros for this are they are cool and convey information nicely. Cons are they are release dependent and would be high maintenance over the long haul. Standard practices usually dictate going with a method that is as divorced as possible from video shots and images of actual GUIs for a product. Rationale is that a person can invoke the tool and see the actual GUI as they read along with any documentation. Changing textual descriptions is a lot less headache than updating videos and screenshots. We need a chapter on Toaster's build functionality. My understanding is that this is the new thing for 1.8. Here are some topics identified that would translate into individual sections: Using Virtualenv manage.py commands Custom layer index I lifted these from the wiki. Some items in the list, such as configuration and setting up instances of Toaster, will be covered in different chapters. Could think about a chapter on using Toaster to debug common issues such as failed dependencies and whatever would be something people might run into. Could maybe include a chapter on the database and other "under-the-cover" stuff that might be useful. I am not sure if any of it would be but it is a thought.