diff options
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 65 |
1 files changed, 20 insertions, 45 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index 5f9b528c6f..cf188aae74 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml | |||
@@ -5207,62 +5207,25 @@ | |||
5207 | </section> | 5207 | </section> |
5208 | </section> | 5208 | </section> |
5209 | 5209 | ||
5210 | <!-- | ||
5211 | <section id="examining-builds-using-toaster"> | 5210 | <section id="examining-builds-using-toaster"> |
5212 | <title>Examining Builds Using the Toaster API</title> | 5211 | <title>Examining Builds Using the Toaster API</title> |
5213 | 5212 | ||
5214 | <para> | 5213 | <para> |
5215 | Toaster is an Application Programming Interface (API) to the | 5214 | Toaster is an Application Programming Interface (API) and |
5216 | OpenEmbedded build system, which uses BitBake. | 5215 | web-based interface to the OpenEmbedded build system, which uses |
5217 | The interface is a Representational State Transfer (REST) API | 5216 | BitBake. |
5218 | that queries for and returns build information using | 5217 | Both interfaces are based on a Representational State Transfer |
5218 | (REST) API that queries for and returns build information using | ||
5219 | <filename>GET</filename> and <filename>JSON</filename>. | 5219 | <filename>GET</filename> and <filename>JSON</filename>. |
5220 | </para> | 5220 | These types of search operations retrieve sets of objects from |
5221 | |||
5222 | <para> | ||
5223 | Through the API you can do the following: | ||
5224 | <itemizedlist> | ||
5225 | <listitem><para>See information about the tasks executed | ||
5226 | and reused during the build.</para></listitem> | ||
5227 | <listitem><para>See what is built (recipes and | ||
5228 | packages) and what packages were installed into the final | ||
5229 | image.</para></listitem> | ||
5230 | <listitem><para>See performance-related information such | ||
5231 | as build time, CPU usage, and disk I/O.</para></listitem> | ||
5232 | <listitem><para>Examine error, warning and trace messages | ||
5233 | to aid in debugging.</para></listitem> | ||
5234 | </itemizedlist> | ||
5235 | </para> | ||
5236 | |||
5237 | <para> | ||
5238 | In summary, the search operation retrieves a set of objects from | ||
5239 | a data store used to collect build information. | 5221 | a data store used to collect build information. |
5240 | The result contains all the data for the objects being returned. | 5222 | The results contain all the data for the objects being returned. |
5241 | You can order the results of the search by key and the search | 5223 | You can order the results of the search by key and the search |
5242 | parameters are consistent for all object types. | 5224 | parameters are consistent for all object types. |
5243 | </para> | 5225 | </para> |
5244 | 5226 | ||
5245 | <para> | 5227 | <para> |
5246 | For more information on installing and running Toaster, see the | 5228 | Using the interfaces you can do the following: |
5247 | "<ulink url='https://wiki.yoctoproject.org/wiki/Web_Hob#Installation_and_Running'>Installation and Running</ulink>" | ||
5248 | section of the "Toaster" wiki page. | ||
5249 | For complete information on the API and its search operation | ||
5250 | URI, parameters, and responses, see the | ||
5251 | <ulink url='https://wiki.yoctoproject.org/wiki/REST_API_Contracts'>REST API Contracts</ulink> | ||
5252 | Wiki page. | ||
5253 | </para> | ||
5254 | </section> | ||
5255 | --> | ||
5256 | |||
5257 | <section id="examining-builds-using-toaster"> | ||
5258 | <title>Examining Builds using Toaster</title> | ||
5259 | |||
5260 | <para> | ||
5261 | Toaster is a Web-based interface to the OpenEmbedded build system, | ||
5262 | which uses BitBake. | ||
5263 | Toaster offers features to record and analyze BitBake runs applied | ||
5264 | to a specific target. | ||
5265 | Using Toaster, you can do the following: | ||
5266 | <itemizedlist> | 5229 | <itemizedlist> |
5267 | <listitem><para>See information about the tasks executed | 5230 | <listitem><para>See information about the tasks executed |
5268 | and reused during the build.</para></listitem> | 5231 | and reused during the build.</para></listitem> |
@@ -5290,6 +5253,18 @@ | |||
5290 | section.</para> | 5253 | section.</para> |
5291 | </note> | 5254 | </note> |
5292 | 5255 | ||
5256 | <para> | ||
5257 | The remainder of this section describes what you need to have in | ||
5258 | place to use Toaster, how to start it, use it, and stop it. | ||
5259 | For additional information on installing and running Toaster, see the | ||
5260 | "<ulink url='https://wiki.yoctoproject.org/wiki/Toaster#Installation_and_Running'>Installation and Running</ulink>" | ||
5261 | section of the "Toaster" wiki page. | ||
5262 | For complete information on the API and its search operation | ||
5263 | URI, parameters, and responses, see the | ||
5264 | <ulink url='https://wiki.yoctoproject.org/wiki/REST_API_Contracts'>REST API Contracts</ulink> | ||
5265 | Wiki page. | ||
5266 | </para> | ||
5267 | |||
5293 | <section id='starting-toaster'> | 5268 | <section id='starting-toaster'> |
5294 | <title>Starting Toaster</title> | 5269 | <title>Starting Toaster</title> |
5295 | 5270 | ||