[OE-core] [PATCH 3/7] linux-yocto-custom: clarify bbappend versus copy in comments

[Bruce Ashfield]

On 2015-05-21 9:19 PM, Andre McCurdy wrote:
> On Thu, May 21, 2015 at 5:59 PM, Bruce Ashfield
> <bruce.ashfield at windriver.com> wrote:
>> On 2015-05-21 5:55 PM, Andre McCurdy wrote:
>>>
>>> On Thu, May 21, 2015 at 12:08 PM, Bruce Ashfield
>>> <bruce.ashfield at windriver.com> wrote:
>>>>
>>>> The kernel development manual recommends making a copy of
>>>> linux-yocto-custom, while the comments in the recipe talk about
>>>> bbappends.
>>>>
>>>> To synchronize the two, we remove the bbappend references from the
>>>> recipe and instead indicate that a copy should be updated.
>>>>
>>>> [YOCTO: #6925]
>>>>
>>>> Signed-off-by: Bruce Ashfield <bruce.ashfield at windriver.com>
>>>> ---
>>>>    meta-skeleton/recipes-kernel/linux/linux-yocto-custom.bb | 10
>>>> +++++-----
>>>>    1 file changed, 5 insertions(+), 5 deletions(-)
>>>>
>>>> diff --git a/meta-skeleton/recipes-kernel/linux/linux-yocto-custom.bb
>>>> b/meta-skeleton/recipes-kernel/linux/linux-yocto-custom.bb
>>>> index 05463c026304..e38af19f827b 100644
>>>> --- a/meta-skeleton/recipes-kernel/linux/linux-yocto-custom.bb
>>>> +++ b/meta-skeleton/recipes-kernel/linux/linux-yocto-custom.bb
>>>> @@ -11,8 +11,8 @@
>>>>    #
>>>>    #   You must also provide a Linux kernel configuration. The most direct
>>>>    #   method is to copy your .config to files/defconfig in your layer,
>>>> -#   in the same directory as the bbappend and add file://defconfig to
>>>> -#   your SRC_URI.
>>>> +#   in the same directory as the copy (and rename) of this recipe and
>>>> +#   add file://defconfig to your SRC_URI.
>>>>    #
>>>>    #   To use the yocto kernel tooling to generate a BSP configuration
>>>>    #   using modular configuration fragments, see the yocto-bsp and
>>>> @@ -52,14 +52,14 @@
>>>>    inherit kernel
>>>>    require recipes-kernel/linux/linux-yocto.inc
>>>>
>>>> -# Override SRC_URI in a bbappend file to point at a different source
>>>> +# Override SRC_URI in a copy of this recipe to point at a different
>>>> source
>>>>    # tree if you do not want to build from Linus' tree.
>>>
>>> Would "Update SRC_URI in your copy of this recipe..." make more sense
>>> here?
>>
>> I avoided possessives on purpose, this could be one of many copies,
>> most may not be 'yours'.
>
> There's already mention of "your layer", "your .config" and "your
> machine", so I don't think "your copy of this recipe" is out of place,
> but "a copy of this recipe" is clear too.

For a trivial patch, I'm just going to leave it as is. Old crimes
don't justify new ones. (and I'm the criminal in all cases ;)

Cheers,

Bruce

>
>>>>    SRC_URI =
>>>> "git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git;protocol=git;nocheckout=1;name=machine"
>>>>
>>>>    LINUX_VERSION ?= "3.4"
>>>>    LINUX_VERSION_EXTENSION ?= "-custom"
>>>>
>>>> -# Override SRCREV to point to a different commit in a bbappend file to
>>>> +# Override SRCREV to point to a different commit in a copy of this
>>>> recipe
>>>>    # build a different release of the Linux kernel.
>>>>    # tag: v3.4 76e10d158efb6d4516018846f60c2ab5501900bc
>>>
>>>
>>> Same comment, "Override" -> "Update" and "a copy" -> "your copy".
>>
>>
>> There's a default SRCREV in many configs, that's why I say override,
>> but update works too.
>>>
>>> Also, the word "to" seems to have gone missing from the end of the line.
>>
>>
>> Indeed. I'll add that back.
>>
>> Bruce
>>
>>
>>>
>>>>    SRCREV_machine="76e10d158efb6d4516018846f60c2ab5501900bc"
>>>> @@ -67,6 +67,6 @@
>>>> SRCREV_machine="76e10d158efb6d4516018846f60c2ab5501900bc"
>>>>    PR = "r1"
>>>>    PV = "${LINUX_VERSION}+git${SRCPV}"
>>>>
>>>> -# Override COMPATIBLE_MACHINE to include your machine in a bbappend
>>>> +# Override COMPATIBLE_MACHINE to include your machine in a copy of this
>>>> recipe
>>>>    # file. Leaving it empty here ensures an early explicit build failure.
>>>>    COMPATIBLE_MACHINE = "(^$)"
>>>> --
>>>> 2.1.0
>>>>
>>>> --
>>>> _______________________________________________
>>>> Openembedded-core mailing list
>>>> Openembedded-core at lists.openembedded.org
>>>> http://lists.openembedded.org/mailman/listinfo/openembedded-core
>>
>>