From: michael.opdenacker@bootlin.com
To: docs@lists.yoctoproject.org
Cc: Michael Opdenacker <michael.opdenacker@bootlin.com>,
Alexander Kanavin <alex@linutronix.de>
Subject: [nanbield][PATCH 11/11] dev-manual: improve descriptions of 'bitbake -S printdiff'
Date: Mon, 25 Mar 2024 14:29:26 +0100 [thread overview]
Message-ID: <20240325132926.3018186-12-michael.opdenacker@bootlin.com> (raw)
In-Reply-To: <20240325132926.3018186-1-michael.opdenacker@bootlin.com>
From: Michael Opdenacker <michael.opdenacker@bootlin.com>
From: Alexander Kanavin <alex.kanavin@gmail.com>
Try to particularly emphasize that it can be used to find
out why something rebuilds when it shouldn't.
Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
documentation/dev-manual/building.rst | 7 +++----
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.
in the script for information on how to use the tool.
- *BitBake's "-S printdiff" Option:* Using this option causes
- BitBake to try to establish the closest signature match it can
- (e.g. in the shared state cache) and then run ``bitbake-diffsigs``
- over the matches to determine the stamps and delta where these two
- stamp trees diverge.
+ BitBake to try to establish the most recent signature match
+ (e.g. in the shared state cache) and then compare matched signatures
+ to determine the stamps and delta where these two stamp trees diverge.
Building Software from an External Source
=========================================
diff --git a/documentation/dev-manual/debugging.rst b/documentation/dev-manual/debugging.rst
index 71b5807f5a..74f5772554 100644
--- a/documentation/dev-manual/debugging.rst
+++ b/documentation/dev-manual/debugging.rst
@@ -339,7 +339,10 @@ BitBake has determined by doing the following:
:term:`BB_BASEHASH_IGNORE_VARS`
information.
-There is also a ``bitbake-diffsigs`` command for comparing two
+Debugging signature construction and unexpected task executions
+===============================================================
+
+There is a ``bitbake-diffsigs`` command for comparing two
``siginfo`` or ``sigdata`` files. This command can be helpful when
trying to figure out what changed between two versions of a task. If you
call ``bitbake-diffsigs`` with just one file, the command behaves like
@@ -356,8 +359,12 @@ BitBake command-line options::
.. note::
Two common values for `SIGNATURE_HANDLER` are "none" and "printdiff", which
- dump only the signature or compare the dumped signature with the cached one,
- respectively.
+ dump only the signature or compare the dumped signature with the most recent one,
+ respectively. "printdiff" will try to establish the most recent
+ signature match (e.g. in the sstate cache) and then
+ compare the matched signatures to determine the stamps and delta
+ where these two stamp trees diverge. This can be used to determine why
+ tasks need to be re-run in situations where that is not expected.
Using BitBake with either of these options causes BitBake to dump out
``sigdata`` files in the ``stamps`` directory for every task it would
--
2.34.1
prev parent reply other threads:[~2024-03-25 13:29 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-03-25 13:29 [nanbield][PATCH 00/11] documentation backports michael.opdenacker
2024-03-25 13:29 ` [nanbield][PATCH 01/11] manuals: add initial stylechecks with Vale michael.opdenacker
2024-03-25 13:29 ` [nanbield][PATCH 02/11] profile-manual: usage.rst: formatting fixes michael.opdenacker
2024-03-25 13:29 ` [nanbield][PATCH 03/11] manuals: use "manual page(s)" michael.opdenacker
2024-03-25 13:29 ` [nanbield][PATCH 04/11] profile-manual: usage.rst: fix reference to bug report michael.opdenacker
2024-03-25 13:29 ` [nanbield][PATCH 05/11] documentation: Makefile: remove releases.rst in "make clean" michael.opdenacker
2024-03-25 13:29 ` [nanbield][PATCH 06/11] migration-guides: add release notes for 4.0.17 michael.opdenacker
2024-03-25 13:29 ` [nanbield][PATCH 07/11] contributor-guide: be more specific about meta-* trees michael.opdenacker
2024-03-25 13:29 ` [nanbield][PATCH 08/11] profile-manual: usage.rst: further style improvements michael.opdenacker
2024-03-25 13:29 ` [nanbield][PATCH 09/11] ref-manual: add documentation of the variable SPDX_NAMESPACE_PREFIX michael.opdenacker
2024-03-25 13:29 ` [nanbield][PATCH 10/11] sdk-manual: correctly describe separate build-sysroots tasks in direct sdk workflows michael.opdenacker
2024-03-25 13:29 ` michael.opdenacker [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240325132926.3018186-12-michael.opdenacker@bootlin.com \
--to=michael.opdenacker@bootlin.com \
--cc=alex@linutronix.de \
--cc=docs@lists.yoctoproject.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.