diff options
Diffstat (limited to 'documentation')
| -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 @@ | |||
| 785 | Because of this, the Yocto Project includes strong debugging | 785 | Because of this, the Yocto Project includes strong debugging |
| 786 | tools: | 786 | tools: |
| 787 | <itemizedlist> | 787 | <itemizedlist> |
| 788 | <listitem><para>Whenever a shared state package is written out, so is a | 788 | <listitem><para>Whenever a shared state package is written |
| 789 | corresponding <filename>.siginfo</filename> file. | 789 | out into the |
| 790 | This practice results in a pickled Python database of all | 790 | <link linkend='var-SSTATE_DIR'><filename>SSTATE_DIR</filename></link>, |
| 791 | the metadata that went into creating the hash for a given shared state | 791 | a corresponding <filename>.siginfo</filename> file is |
| 792 | package.</para></listitem> | 792 | also written. |
| 793 | <listitem><para>If you run BitBake with the <filename>--dump-signatures</filename> | 793 | This file contains a pickled Python database of all |
| 794 | (or <filename>-S</filename>) option, BitBake dumps out | 794 | the Metadata that went into creating the hash for a |
| 795 | <filename>.siginfo</filename> files in | 795 | given shared state package. |
| 796 | the stamp directory for every task it would have executed instead of | 796 | Whenever a stamp is written into the stamp directory |
| 797 | building the specified target package.</para></listitem> | 797 | <link linkend='var-STAMP'><filename>STAMP</filename></link>, |
| 798 | <listitem><para>There is a <filename>bitbake-diffsigs</filename> command that | 798 | a corresponding <filename>.sigdata</filename> file |
| 799 | can process <filename>.siginfo</filename> files. | 799 | is created that contains the same hash data that |
| 800 | If you specify one of these files, BitBake dumps out the dependency | 800 | represented the executed task. |
| 801 | information in the file. | 801 | </para></listitem> |
| 802 | If you specify two files, BitBake compares the two files and dumps out | 802 | <listitem><para>You can use BitBake to dump out the |
| 803 | the differences between the two. | 803 | signature construction information without executing |
| 804 | tasks by using either of the following BitBake | ||
| 805 | command-line options: | ||
| 806 | <literallayout class='monospaced'> | ||
| 807 | ‐‐dump-signatures=<replaceable>SIGNATURE_HANDLER</replaceable> | ||
| 808 | -S <replaceable>SIGNATURE_HANDLER</replaceable> | ||
| 809 | </literallayout> | ||
| 810 | <note> | ||
| 811 | Two common values for | ||
| 812 | <replaceable>SIGNATURE_HANDLER</replaceable> are | ||
| 813 | "none" and "printdiff" to only dump the signature | ||
| 814 | or to compare the dumped signature with the | ||
| 815 | cached one, respectively. | ||
| 816 | </note> | ||
| 817 | Using BitBake with either of these options causes | ||
| 818 | BitBake to dump out <filename>.sigdata</filename> files | ||
| 819 | in the stamp directory for every task it would have | ||
| 820 | executed instead of building the specified target | ||
| 821 | package. | ||
| 822 | </para></listitem> | ||
| 823 | <listitem><para>There is a | ||
| 824 | <filename>bitbake-diffsigs</filename> command that | ||
| 825 | can process <filename>.sigdata</filename> and | ||
| 826 | <filename>.siginfo</filename> files. | ||
| 827 | If you specify one of these files, BitBake dumps out | ||
| 828 | the dependency information in the file. | ||
| 829 | If you specify two files, BitBake compares the two | ||
| 830 | files and dumps out the differences between the two. | ||
| 804 | This more easily helps answer the question of "What | 831 | This more easily helps answer the question of "What |
| 805 | changed between X and Y?"</para></listitem> | 832 | changed between X and Y?"</para></listitem> |
| 806 | </itemizedlist> | 833 | </itemizedlist> |