diff options
-rw-r--r-- | documentation/dev-manual/building.rst | 7 | ||||
-rw-r--r-- | documentation/dev-manual/debugging.rst | 13 |
2 files changed, 13 insertions, 7 deletions
diff --git a/documentation/dev-manual/building.rst b/documentation/dev-manual/building.rst index 7fcac33b75..fe502690dd 100644 --- a/documentation/dev-manual/building.rst +++ b/documentation/dev-manual/building.rst | |||
@@ -775,10 +775,9 @@ your tunings to best consider build times and package feed maintenance. | |||
775 | in the script for information on how to use the tool. | 775 | in the script for information on how to use the tool. |
776 | 776 | ||
777 | - *BitBake's "-S printdiff" Option:* Using this option causes | 777 | - *BitBake's "-S printdiff" Option:* Using this option causes |
778 | BitBake to try to establish the closest signature match it can | 778 | BitBake to try to establish the most recent signature match |
779 | (e.g. in the shared state cache) and then run ``bitbake-diffsigs`` | 779 | (e.g. in the shared state cache) and then compare matched signatures |
780 | over the matches to determine the stamps and delta where these two | 780 | to determine the stamps and delta where these two stamp trees diverge. |
781 | stamp trees diverge. | ||
782 | 781 | ||
783 | Building Software from an External Source | 782 | Building Software from an External Source |
784 | ========================================= | 783 | ========================================= |
diff --git a/documentation/dev-manual/debugging.rst b/documentation/dev-manual/debugging.rst index ce29815e9f..e20637e1c6 100644 --- a/documentation/dev-manual/debugging.rst +++ b/documentation/dev-manual/debugging.rst | |||
@@ -339,7 +339,10 @@ BitBake has determined by doing the following: | |||
339 | :term:`BB_BASEHASH_IGNORE_VARS` | 339 | :term:`BB_BASEHASH_IGNORE_VARS` |
340 | information. | 340 | information. |
341 | 341 | ||
342 | There is also a ``bitbake-diffsigs`` command for comparing two | 342 | Debugging signature construction and unexpected task executions |
343 | =============================================================== | ||
344 | |||
345 | There is a ``bitbake-diffsigs`` command for comparing two | ||
343 | ``siginfo`` or ``sigdata`` files. This command can be helpful when | 346 | ``siginfo`` or ``sigdata`` files. This command can be helpful when |
344 | trying to figure out what changed between two versions of a task. If you | 347 | trying to figure out what changed between two versions of a task. If you |
345 | call ``bitbake-diffsigs`` with just one file, the command behaves like | 348 | call ``bitbake-diffsigs`` with just one file, the command behaves like |
@@ -356,8 +359,12 @@ BitBake command-line options:: | |||
356 | .. note:: | 359 | .. note:: |
357 | 360 | ||
358 | Two common values for `SIGNATURE_HANDLER` are "none" and "printdiff", which | 361 | Two common values for `SIGNATURE_HANDLER` are "none" and "printdiff", which |
359 | dump only the signature or compare the dumped signature with the cached one, | 362 | dump only the signature or compare the dumped signature with the most recent one, |
360 | respectively. | 363 | respectively. "printdiff" will try to establish the most recent |
364 | signature match (e.g. in the sstate cache) and then | ||
365 | compare the matched signatures to determine the stamps and delta | ||
366 | where these two stamp trees diverge. This can be used to determine why | ||
367 | tasks need to be re-run in situations where that is not expected. | ||
361 | 368 | ||
362 | Using BitBake with either of these options causes BitBake to dump out | 369 | Using BitBake with either of these options causes BitBake to dump out |
363 | ``sigdata`` files in the ``stamps`` directory for every task it would | 370 | ``sigdata`` files in the ``stamps`` directory for every task it would |