sysmo-bts
/
generic-poky
9
0
Fork 0
Code Pull Requests Releases Activity

dev-manual: Updates to Toaster section 

Partial fix for [YOCTO #4414]

I put in the API stuff as well as made sure the other comments
for the dora-toaster branch and temporariness of the GUI were
mentioned.  Probably more tweaks before this section settles
out.

(From yocto-docs rev: 54dd0edff55c26fb52941e69b1919e30d7a7ec55)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark 2013-10-30 11:42:59 -07:00 committed by Richard Purdie
parent 26c099f15e
commit 55f35e457d
1 changed files with 20 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
documentation/dev-manual/dev-manual-common-tasks.xml
View File

@ -5207,62 +5207,25 @@
</section>
</section>
<!--
<section id="examining-builds-using-toaster">
<title>Examining Builds Using the Toaster API</title>
<para>
Toaster is an Application Programming Interface (API) to the
OpenEmbedded build system, which uses BitBake.
The interface is a Representational State Transfer (REST) API
that queries for and returns build information using
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
<filename>GET</filename> and <filename>JSON</filename>.
</para>
<para>
Through the API you can do the following:
<itemizedlist>
<listitem><para>See information about the tasks executed
and reused during the build.</para></listitem>
<listitem><para>See what is built (recipes and
packages) and what packages were installed into the final
image.</para></listitem>
<listitem><para>See performance-related information such
as build time, CPU usage, and disk I/O.</para></listitem>
<listitem><para>Examine error, warning and trace messages
to aid in debugging.</para></listitem>
</itemizedlist>
</para>
<para>
In summary, the search operation retrieves a set of objects from
These types of search operations retrieve sets of objects from
a data store used to collect build information.
The result contains all the data for the objects being returned.
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.
</para>
<para>
For more information on installing and running Toaster, see the
"<ulink url='https://wiki.yoctoproject.org/wiki/Web_Hob#Installation_and_Running'>Installation and Running</ulink>"
section of the "Toaster" wiki page.
For complete information on the API and its search operation
URI, parameters, and responses, see the
<ulink url='https://wiki.yoctoproject.org/wiki/REST_API_Contracts'>REST API Contracts</ulink>
Wiki page.
</para>
</section>
-->
<section id="examining-builds-using-toaster">
<title>Examining Builds using Toaster</title>
<para>
Toaster is a Web-based interface to the OpenEmbedded build system,
which uses BitBake.
Toaster offers features to record and analyze BitBake runs applied
to a specific target.
Using Toaster, you can do the following:
Using the interfaces you can do the following:
<itemizedlist>
<listitem><para>See information about the tasks executed
and reused during the build.</para></listitem>
@ -5290,6 +5253,18 @@
section.</para>
</note>
<para>
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
"<ulink url='https://wiki.yoctoproject.org/wiki/Toaster#Installation_and_Running'>Installation and Running</ulink>"
section of the "Toaster" wiki page.
For complete information on the API and its search operation
URI, parameters, and responses, see the
<ulink url='https://wiki.yoctoproject.org/wiki/REST_API_Contracts'>REST API Contracts</ulink>
Wiki page.
</para>
<section id='starting-toaster'>
<title>Starting Toaster</title>