Bug 5684

Summary: Unclear BB_GENERATE_MIRROR_TARBALLS documentation
Product: [Documentation] Reference Reporter: Laszlo Papp <lpapp>
Component: handbookAssignee: Scott Rifenbark <srifenbark>
Status: RESOLVED FIXED QA Contact:
Severity: normal    
Priority: Undecided CC: poky.doc.watcher, poky.watcher, sgw, srifenbark
Version: unspecified   
Target Milestone: ---   
Hardware: x86   
OS: Multiple   
URL: http://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/commit/?id=76cbb8a149b9fda6879f9dfc6a17dab992325e94
Whiteboard: 23 December 2013: RESOLVED
OS type for building Yocto: --- Type of Regression: ---
Verified: Documentation change: Done (doc changes complete)

Description Laszlo Papp 2013-12-20 16:42:10 UTC
From here:

http://www.yoctoproject.org/docs/current/ref-manual/ref-manual.html#var-BB_GENERATE_MIRROR_TARBALLS

"Causes tarballs of the Git repositories to be placed in the DL_DIR directory. For performance reasons, creating and placing tarballs of the Git repositories is not the default action by the OpenEmbedded build system."

It is not clear to me whether it means it only archives like "git archive" does which does not get the git metadata for you, or it will get the source as well as the gita meta information.

I think it could be more explicit, so I am prosing something like this along the lines:

"Causes tarballs of the Git repositories>>>, including the git metadata,<<< to be placed in the DL_DIR directory. For performance reasons, creating and placing tarballs of the Git repositories is not the default action by the OpenEmbedded build system."

This is a minor fix, and would help people like me. It would not cause any misunderstanding for other people either, IMO.
Comment 1 Scott Rifenbark 2013-12-23 19:43:39 UTC
I have implemented the suggested change to the variable description.  Thanks for noting this Laszlo.

You can see the change at http://www.yoctoproject.org/docs/1.6/ref-manual/ref-manual.html#var-BB_GENERATE_MIRROR_TARBALLS

Scott
Comment 2 Laszlo Papp 2013-12-23 19:52:55 UTC
Many thanks; you rock. :)