mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-09-14 03:49:32 +02:00
Code Issues Packages Projects Releases Wiki Activity

ref-manual: Suggested fleshing out of the sigdata/siginfo documentation

Browse Source 
Fixes [YOCTO #10141]

Provided several fixes to address this situation:

 * Renamed "Debugging Build Failures" to "Debugging Tools and
   Techniques" as it fit better the subsections.

 * Renamed "Viewing Dependencies" to "Viewing Dependencies
   Between Recipes and Tasks" as it fit better the description.

 * Added a new "Viewing Task Variable Dependencies" section
   to describe how sigdata and siginfo stuff can be used.

 * Replaced the contents of "4.3.4.1 Debugging" with a shorter
   bit that now references into the new section on veiwing
   task variable dependencies.

(From yocto-docs rev: 539d76366055bed74ccc926519e969324cac470d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark
2016-08-22 13:13:14 -07:00
committed by Richard Purdie
parent a2e8f196d7
commit 1769e1a2de
2 changed files with 130 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
documentation/ref-manual/technical-details.xml
View File

@@ -901,56 +901,15 @@
<title>Debugging</title>
<para>
When things go wrong, debugging needs to be straightforward.
Because of this, the Yocto Project includes strong debugging
tools:
<itemizedlist>
<listitem><para>Whenever a shared state package is written
out into the
<link linkend='var-SSTATE_DIR'><filename>SSTATE_DIR</filename></link>,
a corresponding <filename>.siginfo</filename> file is
also written.
This file contains a pickled Python database of all
the Metadata that went into creating the hash for a
given shared state package.
Whenever a stamp is written into the stamp directory
<link linkend='var-STAMP'><filename>STAMP</filename></link>,
a corresponding <filename>.sigdata</filename> file
is created that contains the same hash data that
represented the executed task.
</para></listitem>
<listitem><para>You can use BitBake to dump out the
signature construction information without executing
tasks by using either of the following BitBake
command-line options:
<literallayout class='monospaced'>
&dash;&dash;dump-signatures=<replaceable>SIGNATURE_HANDLER</replaceable>
-S <replaceable>SIGNATURE_HANDLER</replaceable>
</literallayout>
<note>
Two common values for
<replaceable>SIGNATURE_HANDLER</replaceable> are
"none" and "printdiff" to only dump the signature
or to compare the dumped signature with the
cached one, respectively.
</note>
Using BitBake with either of these options causes
BitBake to dump out <filename>.sigdata</filename> files
in the stamp directory for every task it would have
executed instead of building the specified target
package.
</para></listitem>
<listitem><para>There is a
<filename>bitbake-diffsigs</filename> command that
can process <filename>.sigdata</filename> and
<filename>.siginfo</filename> files.
If you specify one of these files, BitBake dumps out
the dependency information in the file.
If you specify two files, BitBake compares the two
files and dumps out the differences between the two.
This more easily helps answer the question of "What
changed between X and Y?"</para></listitem>
</itemizedlist>
Seeing what metadata went into creating the input signature
of a shared state (sstate) task can be a useful debugging aid.
This information is available in signature information
(<filename>siginfo</filename>) files in
<link linkend='var-SSTATE_DIR'><filename>SSTATE_DIR</filename></link>.
For information on how to view and interpret information in
<filename>siginfo</filename> files, see the
"<link linkend='usingpoky-viewing-task-variable-dependencies'>Viewing Task Variable Dependencies</link>"
section.
</para>
</section>