diff options
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 51 |
1 files changed, 49 insertions, 2 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index 1545258e32..4bdeedb8d7 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml | |||
@@ -4372,6 +4372,50 @@ | |||
4372 | </section> | 4372 | </section> |
4373 | 4373 | ||
4374 | <section id="examining-builds-using-toaster"> | 4374 | <section id="examining-builds-using-toaster"> |
4375 | <title>Examining Builds Using the Toaster API</title> | ||
4376 | |||
4377 | <para> | ||
4378 | Toaster is an Application Programming Interface (API) to the | ||
4379 | OpenEmbedded build system, which uses BitBake. | ||
4380 | The interface is a Representational State Transfer (REST) API | ||
4381 | that queries for and returns build information using | ||
4382 | <filename>GET</filename> and <filename>JSON</filename>. | ||
4383 | </para> | ||
4384 | |||
4385 | <para> | ||
4386 | Through the API you can do the following: | ||
4387 | <itemizedlist> | ||
4388 | <listitem><para>See information about the tasks executed | ||
4389 | and reused during the build.</para></listitem> | ||
4390 | <listitem><para>See what is built (recipes and | ||
4391 | packages) and what packages were installed into the final | ||
4392 | image.</para></listitem> | ||
4393 | <listitem><para>See performance-related information such | ||
4394 | as build time, CPU usage, and disk I/O.</para></listitem> | ||
4395 | <listitem><para>Examine error, warning and trace messages | ||
4396 | to aid in debugging.</para></listitem> | ||
4397 | </itemizedlist> | ||
4398 | </para> | ||
4399 | |||
4400 | <para> | ||
4401 | In summary, the search operation retrieves a set of objects from | ||
4402 | a data store used to collect build information. | ||
4403 | The result contains all the data for the objects being returned. | ||
4404 | You can order the results of the search by key and the search | ||
4405 | parameters are consistent for all object types. | ||
4406 | </para> | ||
4407 | |||
4408 | <para> | ||
4409 | For complete information on the API and its search operation | ||
4410 | URI, parameters, and reposes, see the | ||
4411 | <ulink url='https://wiki.yoctoproject.org/wiki/REST_API_Contracts'>REST API Contracts</ulink> | ||
4412 | Wiki page. | ||
4413 | </para> | ||
4414 | </section> | ||
4415 | |||
4416 | <!-- Commenting out the Toaster GUI stuff as it did not make it for 1.5 | ||
4417 | |||
4418 | <section id="examining-builds-using-toaster"> | ||
4375 | <title>Examining Builds using Toaster</title> | 4419 | <title>Examining Builds using Toaster</title> |
4376 | 4420 | ||
4377 | <para> | 4421 | <para> |
@@ -4510,7 +4554,7 @@ | |||
4510 | execution time, CPU usage and disk I/O per task. | 4554 | execution time, CPU usage and disk I/O per task. |
4511 | </para> | 4555 | </para> |
4512 | 4556 | ||
4513 | <!-- | 4557 | <para> |
4514 | The home page of the interface into the database organizes | 4558 | The home page of the interface into the database organizes |
4515 | builds into areas: | 4559 | builds into areas: |
4516 | <itemizedlist> | 4560 | <itemizedlist> |
@@ -4523,6 +4567,8 @@ | |||
4523 | <listitem><para>All builds, which appear in row format at | 4567 | <listitem><para>All builds, which appear in row format at |
4524 | the end of the page.</para></listitem> | 4568 | the end of the page.</para></listitem> |
4525 | </itemizedlist> | 4569 | </itemizedlist> |
4570 | </para> | ||
4571 | |||
4526 | <para> | 4572 | <para> |
4527 | Each entry is linked to more detail on the particular build | 4573 | Each entry is linked to more detail on the particular build |
4528 | or recipe. | 4574 | or recipe. |
@@ -4540,7 +4586,7 @@ | |||
4540 | task, and package information along with directory structure, | 4586 | task, and package information along with directory structure, |
4541 | build time, CPU usage, and disk I/O information. | 4587 | build time, CPU usage, and disk I/O information. |
4542 | </para> | 4588 | </para> |
4543 | --> | 4589 | |
4544 | </section> | 4590 | </section> |
4545 | 4591 | ||
4546 | <section id='stopping-toaster'> | 4592 | <section id='stopping-toaster'> |
@@ -4555,6 +4601,7 @@ | |||
4555 | </para> | 4601 | </para> |
4556 | </section> | 4602 | </section> |
4557 | </section> | 4603 | </section> |
4604 | --> | ||
4558 | 4605 | ||
4559 | <section id="platdev-oprofile"> | 4606 | <section id="platdev-oprofile"> |
4560 | <title>Profiling with OProfile</title> | 4607 | <title>Profiling with OProfile</title> |