9964 2016-07-18 07:25:11 +0000 Suggested fleshing out of the do_compile documentation 2016-08-01 17:59:07 +0000 1 1 9 Documentation Reference handbook 2.3 x86 Multiple RESOLVED FIXED 29 July 2016: IN PROGRESS REVIEW Medium normal 2.2 M3 1 ulfalizer srifenbark bluelightning poky.doc.watcher poky.watcher sgw srifenbark --- --- Done (doc changes complete) oldest_to_newest 64087 0 ulfalizer 2016-07-18 07:25:11 +0000 Section '8.1.3. do_compile' is very sparse at the moment. I suggest extending it as follows to cover the default behavior and making it clearer that the working directory is ${B}: 8.1.3. do_compile Compiles the source code. Runs with the current working directory set to ${B}. The default behavior of this task is to run 'oe_runmake' if a makefile ("Makefile", "makefile", or "GNUmakefile") is found, and doing nothing otherwise. To also add some documentation for oe_runmake, the final sentence of '7.4. base.bbclass' could be extended from The class also contains some commonly used functions such as oe_runmake. to The class also contains some commonly used functions such as 'oe_runmake', which runs 'make' with the arguments specified in EXTRA_OEMAKE (in addition to the arguments passed directly to 'oe_runmake'). To make it easier to discover how a task gets its current working directory, the sentence The do_deploy[dirs] = "${DEPLOYDIR} ${B}" line creates ${DEPLOYDIR} and ${B} before the do_deploy task runs. in '4.3.3. Shared State' could be extended to The do_deploy[dirs] = "${DEPLOYDIR} ${B}" line creates ${DEPLOYDIR} and ${B} before the do_deploy task runs, and also sets the current working directory of do_deploy to ${B}. 64112 1 srifenbark 2016-07-18 18:49:20 +0000 Ulf, Thanks for helping to describe these more. They are indeed very sparse. Here is the change in the do_compile task section - http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#ref-tasks-compile Here is the change in the base.bbclass section - http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#ref-classes-base Here is the change in 4.3.3 "Shared State" - http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#shared-state Let me know how they are. thanks, Scott 64114 2 ulfalizer 2016-07-18 19:04:48 +0000 Looks good. Just one nit: The default behavior of this task is to run the oe_runmake task... should be The default behavior of this task is to run the oe_runmake function.. Cheers, Ulf 64115 3 ulfalizer 2016-07-18 19:09:19 +0000 I'll piggyback one slightly OCD nit in the glossary entry for B if it's okay: S = "${WORKDIR}/${BP}/" should be S = "${WORKDIR}/${BP}" to match the actual assignment in bitbake.conf. That's also the style I prefer. Cheers, Ulf 64128 4 srifenbark 2016-07-18 20:33:18 +0000 No problems... http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-B I am going to close this bug to RESOLVED and set the flag to "Done." I am assuming we are good now. Thanks, Scott 64383 5 ulfalizer 2016-07-23 11:02:19 +0000 Found one small typo: The default behavior of this task is to run the oe_runmake task... should be The default behavior of this task is to run the oe_runmake function... Cheers, Ulf 64384 6 ulfalizer 2016-07-23 11:02:50 +0000 Reopening for visibility. 64689 7 srifenbark 2016-07-29 22:08:52 +0000 Ulf, Sorry... I don't know how I missed that one in Comment 2. I fixed it. See http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#ref-tasks-compile. Setting to IN PROGRESS REVIEW so you can verify. Thanks, Scott 64697 8 ulfalizer 2016-07-30 08:59:32 +0000 Looks good! Thanks, Ulf 64734 9 srifenbark 2016-08-01 17:59:07 +0000 Setting doc flag to "done". Scott