Bug 5521 - Document file checksums
Summary: Document file checksums
Status: RESOLVED FIXED
Alias: None
Product: Development Manual
Classification: Documentation
Component: development (show other bugs)
Version: unspecified
Hardware: All Multiple
: Medium enhancement
Target Milestone: 1.7 M2
Assignee: Scott Rifenbark
QA Contact:
URL:
Whiteboard: 02 June 2014: RESOLVED
Depends on:
Blocks:
 
Reported: 2013-11-13 16:26 UTC by Paul Eggleton
Modified: 2014-06-19 04:54 UTC (History)
3 users (show)

See Also:
OS type for building Yocto: ---
Type of Regression: ---
Verified:
Documentation change: Done (doc changes complete)


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Paul Eggleton 2013-11-13 16:26:39 UTC
It seems we don't currently document that we take a checksum of every local file mentioned in SRC_URI for a recipe, and insert those checksums into the signature for do_fetch, thus if one of those files is modified, do_fetch and all tasks that depend on it will be re-executed.

I'm not sure where in the documentation this would fit in, but it might be something we can squeeze into the new "creating a new recipe workflow" section.
Comment 1 Scott Rifenbark 2013-11-18 18:13:33 UTC
Paul, 

We could also mention this in the "Closer Look" section where we discuss fetching source files.

Scott
Comment 2 Scott Rifenbark 2014-01-02 19:52:56 UTC
Paul, 

I mention these checksums in the new "Writing a New Recipe" section now.  See http://www.yoctoproject.org/docs/1.6/dev-manual/dev-manual.html#new-recipe-fetching-code.  It is down towards the end of the section.

Also, in the same overall section in "Licensing", there is some discussion of checksums.  See http://www.yoctoproject.org/docs/1.6/dev-manual/dev-manual.html#new-recipe-licensing.

Additionally, there is stuff in http://www.yoctoproject.org/docs/1.6/ref-manual/ref-manual.html#usingpoky-configuring-LIC_FILES_CHKSUM.

I am not sure how much (if any of this) you would consider contributing to this bug.  Maybe you can comment on that.  I think one area that we could mention this is in the SRC_URI variable description of the glossary.
Comment 3 Paul Eggleton 2014-01-02 20:35:20 UTC
I'm afraid this is not related to LIC_FILES_CHKSUM at all; these checksums are internal ones taken for local files so we can detect when they are changed and force a fetch to occur.
Comment 4 Scott Rifenbark 2014-01-02 21:29:41 UTC
What about the stuff in the "Writing a New Recipe" section?  Don't those have to do with SRC_URI?
Comment 5 Paul Eggleton 2014-01-02 21:40:50 UTC
They do have to do with SRC_URI yes, but those explicit SRC_URI checksums are for *remote* files.

Other than that a checksum is being used, and SRC_URI is involved, this feature is not related to either SRC_URI[md5sum]/SRC_URI[sha256sum] or LIC_FILES_CHKSUM.
Comment 6 Scott Rifenbark 2014-01-02 21:56:10 UTC
Okay - I will go back to square one on this.

Thanks
Comment 7 Scott Rifenbark 2014-04-01 22:36:46 UTC
Enhancement - moving to 1.7.
Comment 8 Scott Rifenbark 2014-06-02 14:21:48 UTC
Hi, 

I have inserted a brief note here to deal with how the build system uses checksums during do_fetch to re-execute stuff if a file:// listed in the SRC_URI has had its contents modified.  Paul has reviewed the note and approved.  I am marking the bug RESOLVED and setting the doc flag to "Done".

Thanks, 
Scott
Comment 9 Scott Rifenbark 2014-06-19 04:54:29 UTC
Set to M2 to get it off the lists.