8542 2015-10-19 18:27:06 +0000 The S entry in the glossary does not make it clear that S can be an input 2016-03-22 16:21:28 +0000 1 1 9 Documentation Reference handbook 1.8 x86 Multiple RESOLVED FIXED 21 March 2016: RESOLVED Medium normal 2.1 M4 1 ulfalizer srifenbark bluelightning poky.doc.watcher poky.watcher srifenbark --- --- Done (doc changes complete) oldest_to_newest 55453 0 ulfalizer 2015-10-19 18:27:06 +0000 The glossary in the reference manual does not make it clear that S can be set by the user (recipe writer) to tell Yocto where the source is after unpacking. I suggest the following rewording (provided it's the correct interpretation - I'm still a bit confused): "S The location in the Build Directory where unpacked recipe source code resides. Defaults to ${WORKDIR}/${BPN}-${PV}, where ${BPN} is the base recipe name and ${PV} the recipe version. If the source tarball extracts the code to a directory called something other than ${BPN}-${PV}, or if the source code if fetched from an SCM like Git or Subversion, then S needs to be set in the recipe to tell Yocto where to find the unpacked source. As an example, assume a Source Directory top-level folder named poky and a default Build Directory at poky/build. In this case, the work directory the build system uses to keep the unpacked recipe for db would be the following by default: poky/build/tmp/work/qemux86-poky-linux/db/5.1.19-r3/db-5.1.19" 55581 1 srifenbark 2015-10-21 18:09:27 +0000 Moving to 2.1. Note to self: I will need to back-port this to some other branches. 55584 2 srifenbark 2015-10-21 18:40:29 +0000 Here are some more implementation notes for me when I get to this issue: * Convey that S points to where the source has been extracted, and that the user needs to actually set it * adjust the example to talk about the db-5.1.1.9 subdirectory of the workdir rather than just pasting the full path 58688 3 srifenbark 2016-02-05 22:50:59 +0000 Hi, Take a look at the variable description at http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#var-S. Let me know if this is okay. Thanks, Scott 58701 4 ulfalizer 2016-02-06 10:09:46 +0000 Looks good. One more thing I'd add is an example that involves Git, because it's a very common case yet doesn't seem to get mentioned much. I'm thinking of something like the following: For example, BitBake's [Git fetcher](http://www.yoctoproject.org/docs/2.1/bitbake-user-manual/bitbake-user-manual.html#git-fetcher) checks out source code to ${WORKDIR}/git by default. Since this path differs from the default value of S, it needs to be set explicitly as follows: SRC_URI = "git://path/to/repo.git" S = "${WORKDIR}/git" 59047 5 srifenbark 2016-02-15 18:33:01 +0000 Hi, Take a look at the change I put into the S variable description in the glossary at http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#var-S. Let me know if this works. Thanks, Scott 59049 6 ulfalizer 2016-02-15 18:52:18 +0000 Looks good - thanks! Maybe it could be phrased like this to emphasize that it's a fetch-related default, though it's pretty minor: This next example assumes a Git repository. By default, Git repositories are cloned to ${WORKDIR}/git during do_fetch. Since this path is different from the default value of S, it must be set explicitly so the source can be located: SRC_URI = "git://path/to/repo.git" S = "${WORKDIR}/git" 59051 7 srifenbark 2016-02-15 18:59:55 +0000 Fair enough ... changed. See http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#var-S Thanks 60297 8 srifenbark 2016-03-22 16:21:28 +0000 no further comments.. closing this one.