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

dev-manual: Updated "Toaster" section to be API-only. 

Fixes [YOCTO #4730]

The web interface for Toaster was cut from the 1.5 release.
I have commented out the existing section and replaced it with
a short introductory section for the API only.

(From yocto-docs rev: 7864e6d9958a9e582f5035f28afb063ef584396a)

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-09-12 10:05:51 -07:00 committed by Richard Purdie
parent 4e7dde77de
commit b1b9f43ca4
1 changed files with 49 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -4371,6 +4371,50 @@
</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
<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
a data store used to collect build information.
The result contains 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 complete information on the API and its search operation
URI, parameters, and reposes, see the
<ulink url='https://wiki.yoctoproject.org/wiki/REST_API_Contracts'>REST API Contracts</ulink>
Wiki page.
</para>
</section>
<!-- Commenting out the Toaster GUI stuff as it did not make it for 1.5
<section id="examining-builds-using-toaster">
<title>Examining Builds using Toaster</title>
@ -4510,7 +4554,7 @@
execution time, CPU usage and disk I/O per task.
</para>
<!--
<para>
The home page of the interface into the database organizes
builds into areas:
<itemizedlist>
@ -4523,6 +4567,8 @@
<listitem><para>All builds, which appear in row format at
the end of the page.</para></listitem>
</itemizedlist>
</para>
<para>
Each entry is linked to more detail on the particular build
or recipe.
@ -4540,7 +4586,7 @@
task, and package information along with directory structure,
build time, CPU usage, and disk I/O information.
</para>
-->
</section>
<section id='stopping-toaster'>
@ -4555,6 +4601,7 @@
</para>
</section>
</section>
-->
<section id="platdev-oprofile">
<title>Profiling with OProfile</title>