| Message ID | 20240318150211.1192651-1-alex@linutronix.de |
|---|---|
| State | New |
| Headers | show |
| Series | [1/3] dev-manual: improve descriptions of 'bitbake -S printdiff' | expand |
Hi Alex Many thanks for the patch! On 3/18/24 at 16:02, Alexander Kanavin wrote: > 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> > --- > 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 7fcac33b754..e0d0aae85d0 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 it can s/it can/it can find/ ? IMHO it would clarify the sentence. If you agree, I can make the change directly, no need for a new submission. Cheers Michael.
On Tue, 19 Mar 2024 at 10:27, Michael Opdenacker <michael.opdenacker@bootlin.com> wrote: > > - (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 it can > > > s/it can/it can find/ ? > IMHO it would clarify the sentence. > If you agree, I can make the change directly, no need for a new submission. I think 'it can' can simply be dropped from both paragraphs without loss of meaning? Alex
On 3/19/24 at 11:50, Alexander Kanavin wrote: > On Tue, 19 Mar 2024 at 10:27, Michael Opdenacker > <michael.opdenacker@bootlin.com> wrote: >>> - (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 it can >> >> s/it can/it can find/ ? >> IMHO it would clarify the sentence. >> If you agree, I can make the change directly, no need for a new submission. > I think 'it can' can simply be dropped from both paragraphs without > loss of meaning? Oh right, that's the simplest solution indeed! Done. Merged into "master-next". Thanks again. Cheers Michael.
diff --git a/documentation/dev-manual/building.rst b/documentation/dev-manual/building.rst index 7fcac33b754..e0d0aae85d0 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 it can + (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 ce29815e9f5..9f87f48cec8 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 it can (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
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> --- documentation/dev-manual/building.rst | 7 +++---- documentation/dev-manual/debugging.rst | 13 ++++++++++--- 2 files changed, 13 insertions(+), 7 deletions(-)