summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/usingpoky.xml66
1 files changed, 40 insertions, 26 deletions
diff --git a/documentation/ref-manual/usingpoky.xml b/documentation/ref-manual/usingpoky.xml
index ecc2ea3653..15e1d47301 100644
--- a/documentation/ref-manual/usingpoky.xml
+++ b/documentation/ref-manual/usingpoky.xml
@@ -253,7 +253,8 @@
253 <para> 253 <para>
254 Sometimes it can be hard to see why BitBake wants to build other 254 Sometimes it can be hard to see why BitBake wants to build other
255 recipes before the one you have specified. 255 recipes before the one you have specified.
256 Dependency information can help you understand recipe build order. 256 Dependency information can help you understand why a recipe is
257 built.
257 </para> 258 </para>
258 259
259 <para> 260 <para>
@@ -293,32 +294,45 @@
293 <para> 294 <para>
294 The graphs are in 295 The graphs are in
295 <ulink url='https://en.wikipedia.org/wiki/DOT_%28graph_description_language%29'>DOT</ulink> 296 <ulink url='https://en.wikipedia.org/wiki/DOT_%28graph_description_language%29'>DOT</ulink>
296 format and can be converted to images (e.g. using the "dot" tool 297 format and can be converted to images (e.g. using the
297 from 298 <filename>dot</filename> tool from
298 <ulink url='http://www.graphviz.org/'>Graphviz</ulink>. 299 <ulink url='http://www.graphviz.org/'>Graphviz</ulink>).
299 <note> 300 <note><title>Notes</title>
300 <para>DOT files use a plain text format. 301 <itemizedlist>
301 The graphs generated using the 302 <listitem><para>
302 <filename>bitbake -g</filename> command are often so large as 303 DOT files use a plain text format.
303 to be impossible to read without special pruning (e.g. with 304 The graphs generated using the
304 Bitbake's <filename>-I</filename> option) and processing. 305 <filename>bitbake -g</filename> command are often so
305 Despite the form and size of the files, the corresponding 306 large as to be difficult to read without special
306 <filename>.dot</filename> files can still be easy to read 307 pruning (e.g. with Bitbake's
307 and provide useful information.</para> 308 <filename>-I</filename> option) and processing.
308 309 Despite the form and size of the graphs, the
309 <para>As an example, the 310 corresponding <filename>.dot</filename> files can still
310 <filename>task-depends.dot</filename> file contains lines such 311 be possible to read and provide useful information.
311 as the following: 312 </para>
312 <literallayout class='monospaced'> 313
314 <para>As an example, the
315 <filename>task-depends.dot</filename> file contains
316 lines such as the following:
317 <literallayout class='monospaced'>
313 "libxslt.do_configure" -> "libxml2.do_populate_sysroot" 318 "libxslt.do_configure" -> "libxml2.do_populate_sysroot"
314 </literallayout> 319 </literallayout>
315 The above example line reveals that the 320 The above example line reveals that the
316 <link linkend='ref-tasks-configure'><filename>do_configure</filename></link> 321 <link linkend='ref-tasks-configure'><filename>do_configure</filename></link>
317 task in <filename>libxslt</filename> depends on the 322 task in <filename>libxslt</filename> depends on the
318 <link linkend='ref-tasks-populate_sysroot'><filename>do_populate_sysroot</filename></link> 323 <link linkend='ref-tasks-populate_sysroot'><filename>do_populate_sysroot</filename></link>
319 task in <filename>libxml2</filename>, which is a normal 324 task in <filename>libxml2</filename>, which is a normal
320 <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link> 325 <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>
321 dependency between the two recipes.</para> 326 dependency between the two recipes.
327 </para></listitem>
328 <listitem><para>
329 For an example of how <filename>.dot</filename> files
330 can be processed, see the
331 <filename>scripts/contrib/graph-tool</filename> Python
332 script, which finds and displays paths between graph
333 nodes.
334 </para></listitem>
335 </itemizedlist>
322 </note> 336 </note>
323 </para> 337 </para>
324 338