Bug 9336

Summary:	Clarify and update bitbake-diffsigs documentation
Product:	[Documentation] Reference	Reporter:	Randy Witt <randy.e.witt>
Component:	handbook	Assignee:	Scott Rifenbark <srifenbark>
Status:	VERIFIED FIXED	QA Contact:	Bogdan Alexandru Voiculescu <bogdanx.a.voiculescu>
Severity:	normal
Priority:	Medium+	CC:	bogdanx.a.voiculescu, poky.doc.watcher, poky.watcher, richard.purdie, srifenbark
Version:	2.0
Target Milestone:	2.1 M4
Hardware:	x86
OS:	Multiple
Whiteboard:	01 April 2016: RESOLVED
OS type for building Yocto:	---	Type of Regression:	---
Verified:		Documentation change:	Done (doc changes complete)

Description Randy Witt 2016-03-23 23:38:09 UTC

The https://www.yoctoproject.org/docs/current/ref-manual/ref-manual.html#debugging section of the manual references using "bitbake -S" and "bitbake-diffsigs".

I tried to follow this documentation, and the first thing I noticed was that "bitbake -S" doesn't work without an argument.

The second thing is that .siginfo files aren't used by bitbake-diffsigs, it uses .sigdata files.

I'm not sure how to fix the documenation for sure, because I was trying to use the documentation.

Comment 1 Scott Rifenbark 2016-03-31 23:42:56 UTC

I talked with Richard and got some information on this.  See the http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#debugging section and let me know if this clears things up.  I added more detail about the BB command-line options and fixed the wrong file name.

Scott

Comment 2 Richard Purdie 2016-04-01 09:09:23 UTC

Scott: This needs to say "Whenever a shared state package is written out into the SSTATE_DIR, so is a corresponding .siginfo file. This file contains a pickled Python database of all the metadata that went into creating the hash for a given shared state package. Whenever a stamp is written into the stamp directory STAMPS, there is also a corresponding .sigdata file containg the same data for the hash which represented the executed task."

and

"There is a bitbake-diffsigs command that can process .sigdata and .siginfo files"

Comment 3 Scott Rifenbark 2016-04-01 15:51:51 UTC

Hi, 

See http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#tips-and-tricks for the final.  Richard approved it so I am marking the bug RESOLVED and setting the doc flag to "done."

Thanks, 
Scott

Comment 4 Bogdan Alexandru Voiculescu 2016-05-09 14:25:15 UTC

Information is added to manual. Marked as verified.