[eclipse-yocto] setup.sh patches for #13050

[Tim Orling]

Merged (to oxygen-master, oxygen/thud, oxygen/sumo, neon-master, neon/thud, neon/sumo and master, plus their contrib/ brethren, as appropriate). All review comments have been addressed, although the commit history will look a bit odd.

Normally some of these commits should have been squashed, but given time and resourcing it is better to get these merged. I did drop the “v1”, “v2” etc. from the [YOCTO #13050] tag. The reason for that tag format is so that it is matchable by a regular expression (machine readable). The place for v2 comments is after the ‘---‘ in the commit log or patch email. I believe you were trying to mark the sequential series as to which patch version they corresponded to, but really v3 should be standalone without the prior sequence (hence my initial comment about squashing). We do not want patch version comments in git history, placing them below the ‘---‘ means that they are visible in patch emails, but will not appear in git history. Git history and YOCTO tags should not have any awareness of patch versions or review history.

The way to manage that is to create a new feature branch for v2, v3 etc. So you could have had cha/yocto-13050-oxygen-master-v2 and then cha/yocto-13050-oxygen-master-v3. The ‘v2’ branch would apply cleanly on top of upstream oxygen-master with all review comments addressed and then the same for ‘v3’ branch. So this really should have been 3 commits rather than 6 on each final v3 branch.

I was looking for where the above guidelines are captured and could not find it. It is also not currently being tested (for oe-core patches) by patchtest. I guess it is in the email archives and review comments of poky and oe-core patches and needs to be documented (on the wiki [1]) and captured in a patchtest [2]. Not that patchtest is run on eclipse-yocto mailing list patches, but we are trying to follow the same commit guidelines. Ultimately these guidelines are inspired by those of the Linux kernel [3].

Thank you for all your work on this bug.

[1] https://www.openembedded.org/wiki/Commit_Patch_Message_Guidelines
[2] http://git.yoctoproject.org/cgit/cgit.cgi/patchtest-oe/
[3] https://www.kernel.org/doc/html/v4.17/process/submitting-patches.html

> On Jan 11, 2019, at 1:47 AM, Ang, Chin Huat <chin.huat.ang at intel.com> wrote:
> 
> Hi Tim,
> 
> I've updated the patches to generate trace.ini when -q or --quiet is not set.
> 
> Just as before, the follow patches:
> 
>  * neon-master, v3 [1]
>  * oxygen-master, v3 [2]
>  * master, v2 [3]
> 
> ... have also been rebased (as necessary) and pushed to the following eclipse-yocto-contrib branches:
> 
>  * cha/yocto-13050-neon-master [4]
>  * cha/yocto-13050-oxygen-master [5]
>  * cha/yocto-13050-master [6]
> 
> --Chin Huat
> 
> [1] https://lists.yoctoproject.org/pipermail/eclipse-yocto/2019-January/000245.html
> [2] https://lists.yoctoproject.org/pipermail/eclipse-yocto/2019-January/000250.html
> [3] https://lists.yoctoproject.org/pipermail/eclipse-yocto/2019-January/000256.html
> [4] http://git.yoctoproject.org/cgit/cgit.cgi/eclipse-yocto-contrib/log/?h=cha/yocto-13050-neon-master
> [5] http://git.yoctoproject.org/cgit/cgit.cgi/eclipse-yocto-contrib/log/?h=cha/yocto-13050-oxygen-master
> [6] http://git.yoctoproject.org/cgit/cgit.cgi/eclipse-yocto-contrib/log/?h=cha/yocto-13050-master
> ________________________________________
> From: Tim Orling [timothy.t.orling at linux.intel.com]
> Sent: Friday, January 11, 2019 1:59 PM
> To: Tim Orling
> Cc: Ang, Chin Huat; Orling, Timothy T; eclipse-yocto at yoctoproject.org
> Subject: Re: [eclipse-yocto] setup.sh patches for #13050
> 
> This [1]:
> [ "$P2_INSTALL_TRACE" == "1" ] && TRACE_OPTS="-debug ./trace.ini”
> 
> means that you are forcing the user to run the setup.sh script from within the scripts directory (e.g. `cd ./scripts && ./setup.sh`). I have always run `./scripts/setup.sh`. Yes, the auto builder job does `cd ./scripts && ./setup.sh`, but we should always try to make our scripts be path agnostic.
> 
> Also, rather than include the trace.ini file, echo it to `pwd`/trace.ini, similar to what you did with [2]:
> 
> [ $USE_UPSTREAM -eq 0 ] && echo "eclipse.p2.mirrors=false" >> eclipse/configuration/config.ini
> 
> 
> It is slightly more complicated than that, but I accidentally wiped out my PoC of doing it with echo in the setup.sh script. I will try to recreate that change and post in another email (tomorrow or so), unless the following is enough guidance for you ?
> 
> Essentially what I had was checking for the value of P2_INSTALL_TRACE=1 and then checking if `pwd`/trace.ini already existed (deleting it) and then (re)creating it with
> 
> echo "org.eclipse.equinox.p2.core/debug=true” > `pwd`/trace.ini
> echo “org.eclipse.equinox.p2.core/artifacts/mirrors=true” >> `pwd`/trace.ini
> 
> This also means that on line 281 it becomes TRACE_OPTS="-debug `pwd`/trace.ini"
> 
> [1] http://git.yoctoproject.org/cgit/cgit.cgi/eclipse-yocto-contrib/tree/scripts/setup.sh?h=cha/yocto-13050-oxygen-master#n281
> 
> [2] http://git.yoctoproject.org/cgit/cgit.cgi/eclipse-yocto-contrib/tree/scripts/setup.sh?h=cha/yocto-13050-oxygen-master#n172
> 
> 
>> On Dec 18, 2018, at 9:18 PM, Tim Orling <ticotimo at gmail.com> wrote:
>> 
>> Thank you, i’ll have a look in the morning.
>> 
>> On Tue, Dec 18, 2018 at 9:14 PM Ang, Chin Huat <chin.huat.ang at intel.com> wrote:
>> For convenience, the patches submitted earlier targeting the following branches:
>> 
>>  * neon-master [1]
>>  * oxygen-master [2]
>>  * master [3]
>> 
>> can also be found at the following eclipse-yocto-contrib branches:
>> 
>>  * cha/yocto-13050-neon-master [4]
>>  * cha/yocto-13050-oxygen-master [5]
>>  * cha/yocto-13050-master [6]
>> 
>> --Chin Huat
>> 
>> 
>> [1] https://lists.yoctoproject.org/pipermail/eclipse-yocto/2018-December/000224.html
>> [2] https://lists.yoctoproject.org/pipermail/eclipse-yocto/2018-December/000227.html
>> [3] https://lists.yoctoproject.org/pipermail/eclipse-yocto/2018-December/000231.html
>> [4] http://git.yoctoproject.org/cgit/cgit.cgi/eclipse-yocto-contrib/log/?h=cha/yocto-13050-neon-master
>> [5] http://git.yoctoproject.org/cgit/cgit.cgi/eclipse-yocto-contrib/log/?h=cha/yocto-13050-oxygen-master
>> [6] http://git.yoctoproject.org/cgit/cgit.cgi/eclipse-yocto-contrib/log/?h=cha/yocto-13050-master
>> _______________________________________________
>> eclipse-yocto mailing list
>> eclipse-yocto at yoctoproject.org
>> https://lists.yoctoproject.org/listinfo/eclipse-yocto
>> _______________________________________________
>> eclipse-yocto mailing list
>> eclipse-yocto at yoctoproject.org
>> https://lists.yoctoproject.org/listinfo/eclipse-yocto
>