diff options
| author |   Scott Rifenbark <srifenbark@gmail.com> | 2016-03-31 16:45:29 -0700 |
|---|---|---|
| committer |   Richard Purdie <richard.purdie@linuxfoundation.org> | 2016-04-06 23:11:57 +0100 |
| commit | 879eec203bc3a07bfcbcba9600a02f9c29a69db9 (patch) | |
| tree | 6d42659d1738a0b92969c2c792d5c5e31809005a /documentation/ref-manual | |
| parent | 23dbf81eddb3c539875b29885ff52e2f116887ef (diff) | |
| download | openembedded-core-contrib-879eec203bc3a07bfcbcba9600a02f9c29a69db9.tar.gz | |
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>
Diffstat (limited to 'documentation/ref-manual')
| -rw-r--r-- | documentation/ref-manual/technical-details.xml | 59 |
1 files changed, 43 insertions, 16 deletions
diff --git a/documentation/ref-manual/technical-details.xml b/documentation/ref-manual/technical-details.xml index 87d7387ab8..f06382ab52 100644 --- a/documentation/ref-manual/technical-details.xml +++ b/documentation/ref-manual/technical-details.xml @@ -785,22 +785,49 @@ Because of this, the Yocto Project includes strong debugging tools: <itemizedlist> - <listitem><para>Whenever a shared state package is written out, so is a - corresponding <filename>.siginfo</filename> file. - This practice results in a pickled Python database of all - the metadata that went into creating the hash for a given shared state - package.</para></listitem> - <listitem><para>If you run BitBake with the <filename>--dump-signatures</filename> - (or <filename>-S</filename>) option, BitBake dumps out - <filename>.siginfo</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>.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. + <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'> + ‐‐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> |