1
0
mirror of https://git.yoctoproject.org/poky synced 2026-05-08 05:09:24 +00:00

ref-manual: Updated debugging tips and tricks

Fixes [YOCTO #9336]

I updated the "Debugging" section within the "Tips and Tricks"
section.  The list of items did not provide detail on two
BitBake command-line options you could use to dump out
signature data into .sigdata files.  Also, the .sigdata files
were incorrectly referred to as .siginfo files.

(From yocto-docs rev: 7836c386f4f7c011de710b6ec9f6be13045dc559)

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-03-31 16:45:29 -07:00
committed by Richard Purdie
parent 23dbf81edd
commit 879eec203b
+43 -16
View File
@@ -785,22 +785,49 @@
Because of this, the Yocto Project includes strong debugging Because of this, the Yocto Project includes strong debugging
tools: tools:
<itemizedlist> <itemizedlist>
<listitem><para>Whenever a shared state package is written out, so is a <listitem><para>Whenever a shared state package is written
corresponding <filename>.siginfo</filename> file. out into the
This practice results in a pickled Python database of all <link linkend='var-SSTATE_DIR'><filename>SSTATE_DIR</filename></link>,
the metadata that went into creating the hash for a given shared state a corresponding <filename>.siginfo</filename> file is
package.</para></listitem> also written.
<listitem><para>If you run BitBake with the <filename>--dump-signatures</filename> This file contains a pickled Python database of all
(or <filename>-S</filename>) option, BitBake dumps out the Metadata that went into creating the hash for a
<filename>.siginfo</filename> files in given shared state package.
the stamp directory for every task it would have executed instead of Whenever a stamp is written into the stamp directory
building the specified target package.</para></listitem> <link linkend='var-STAMP'><filename>STAMP</filename></link>,
<listitem><para>There is a <filename>bitbake-diffsigs</filename> command that a corresponding <filename>.sigdata</filename> file
can process <filename>.siginfo</filename> files. is created that contains the same hash data that
If you specify one of these files, BitBake dumps out the dependency represented the executed task.
information in the file. </para></listitem>
If you specify two files, BitBake compares the two files and dumps out <listitem><para>You can use BitBake to dump out the
the differences between the two. 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 This more easily helps answer the question of "What
changed between X and Y?"</para></listitem> changed between X and Y?"</para></listitem>
</itemizedlist> </itemizedlist>