bitbake: user-manual-execution.xml: Updated "Checksum (Signatures) section.

Fixes [YOCTO #5357]

Added a paragraph at the end of this section to address the fact
that the user can now debug Bitbake's processing of signatures.
This introduces the -S bitbake option and the fact that the
user can provide a couple parameters with it: "none" and
"printdiff".

(Bitbake rev: 4093fa6c96eebe0bbafb93dc27d8a978cca436c4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>

1 files changed, 24 insertions, 0 deletions

diff --git a/bitbake/doc/user-manual/user-manual-execution.xml b/bitbake/doc/user-manual/user-manual-execution.xml
index a67516e858..d5a288c03f 100644
--- a/bitbake/doc/user-manual/user-manual-execution.xml
+++ b/bitbake/doc/user-manual/user-manual-execution.xml
@@ -751,6 +751,30 @@
         </para>
 
         <para>
+            It is worth noting that BitBake's "-S" option lets you
+            debug Bitbake's processing of signatures.
+            The options passed to -S allow different debugging modes
+            to be used, either using BitBake's own debug functions
+            or possibly those defined in the metadata/signature handler
+            itself.
+            The simplest parameter to pass is "none", which causes a
+            set of signature information to be written out into
+            <filename>STAMP_DIR</filename>
+            corresponding to the targets specified.
+            The other currently available parameter is "printdiff",
+            which causes BitBake to try to establish the closest
+            signature match it can (e.g. in the sstate cache) and then
+            run <filename>bitbake-diffsigs</filename> over the matches
+            to determine the stamps and delta where these two
+            stamp trees diverge.
+            <note>
+                It is likely that future versions of BitBake with
+                provide other signature handlers triggered through
+                additional "-S" paramters.
+            </note>
+        </para>
+
+        <para>
             You can find more information on checksum metadata in the
             "<link linkend='task-checksums-and-setscene'>Task Checksums and Setscene</link>"
             section.