aboutsummaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2016-08-12 14:47:13 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2016-08-18 23:50:47 +0100
commitf1d2a932f63200b60aa3b1077e8e43d8f4d6d0bb (patch)
tree1f962b5cf02caae50de87bd8e56242d8aa64ced0 /documentation/ref-manual
parentb249c8d2d5f728a4713685ddc7ef2a66fd931d0e (diff)
downloadopenembedded-core-contrib-f1d2a932f63200b60aa3b1077e8e43d8f4d6d0bb.tar.gz
ref-manual: Applied review edits to "Viewing Dependencies"
Fixes [YOCTO #10131] Fixed some small issues here and there. Also, provided a second itemized item in the note box turning it into a notes box. (From yocto-docs rev: a736c3bb707e81eda7760c642084a5a7c4de2539) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-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 @@
<para>
Sometimes it can be hard to see why BitBake wants to build other
recipes before the one you have specified.
- Dependency information can help you understand recipe build order.
+ Dependency information can help you understand why a recipe is
+ built.
</para>
<para>
@@ -293,32 +294,45 @@
<para>
The graphs are in
<ulink url='https://en.wikipedia.org/wiki/DOT_%28graph_description_language%29'>DOT</ulink>
- format and can be converted to images (e.g. using the "dot" tool
- from
- <ulink url='http://www.graphviz.org/'>Graphviz</ulink>.
- <note>
- <para>DOT files use a plain text format.
- The graphs generated using the
- <filename>bitbake -g</filename> command are often so large as
- to be impossible to read without special pruning (e.g. with
- Bitbake's <filename>-I</filename> option) and processing.
- Despite the form and size of the files, the corresponding
- <filename>.dot</filename> files can still be easy to read
- and provide useful information.</para>
-
- <para>As an example, the
- <filename>task-depends.dot</filename> file contains lines such
- as the following:
- <literallayout class='monospaced'>
+ format and can be converted to images (e.g. using the
+ <filename>dot</filename> tool from
+ <ulink url='http://www.graphviz.org/'>Graphviz</ulink>).
+ <note><title>Notes</title>
+ <itemizedlist>
+ <listitem><para>
+ DOT files use a plain text format.
+ The graphs generated using the
+ <filename>bitbake -g</filename> command are often so
+ large as to be difficult to read without special
+ pruning (e.g. with Bitbake's
+ <filename>-I</filename> option) and processing.
+ Despite the form and size of the graphs, the
+ corresponding <filename>.dot</filename> files can still
+ be possible to read and provide useful information.
+ </para>
+
+ <para>As an example, the
+ <filename>task-depends.dot</filename> file contains
+ lines such as the following:
+ <literallayout class='monospaced'>
"libxslt.do_configure" -> "libxml2.do_populate_sysroot"
- </literallayout>
- The above example line reveals that the
- <link linkend='ref-tasks-configure'><filename>do_configure</filename></link>
- task in <filename>libxslt</filename> depends on the
- <link linkend='ref-tasks-populate_sysroot'><filename>do_populate_sysroot</filename></link>
- task in <filename>libxml2</filename>, which is a normal
- <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>
- dependency between the two recipes.</para>
+ </literallayout>
+ The above example line reveals that the
+ <link linkend='ref-tasks-configure'><filename>do_configure</filename></link>
+ task in <filename>libxslt</filename> depends on the
+ <link linkend='ref-tasks-populate_sysroot'><filename>do_populate_sysroot</filename></link>
+ task in <filename>libxml2</filename>, which is a normal
+ <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>
+ dependency between the two recipes.
+ </para></listitem>
+ <listitem><para>
+ For an example of how <filename>.dot</filename> files
+ can be processed, see the
+ <filename>scripts/contrib/graph-tool</filename> Python
+ script, which finds and displays paths between graph
+ nodes.
+ </para></listitem>
+ </itemizedlist>
</note>
</para>