diff mbox series

ref-manual/variables.rst: fix wording in COMPATIBLE_MACHINE note

Message ID 20260409094035.346379-1-joaomarcos.costa@bootlin.com
State New
Headers show
Series ref-manual/variables.rst: fix wording in COMPATIBLE_MACHINE note | expand

Commit Message

Joao Marcos Costa April 9, 2026, 9:40 a.m. UTC
Add missing "that" between "recipe" and "inherits".

Signed-off-by: João Marcos Costa <joaomarcos.costa@bootlin.com>
---
 documentation/ref-manual/variables.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Quentin Schulz April 9, 2026, 10:29 a.m. UTC | #1
Hi João,

On 4/9/26 11:40 AM, Joao Marcos Costa via lists.yoctoproject.org wrote:
> Add missing "that" between "recipe" and "inherits".
> 
> Signed-off-by: João Marcos Costa <joaomarcos.costa@bootlin.com>
> ---
>   documentation/ref-manual/variables.rst | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index 60e608c0c..8466124e0 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -1679,7 +1679,7 @@ system and gives an overview of their function and contents.
>   
>         .. note::
>   
> -         When :term:`COMPATIBLE_MACHINE` is set in a recipe inherits from
> +         When :term:`COMPATIBLE_MACHINE` is set in a recipe that inherits from
>            native, the recipe is always skipped. All native recipes must be

Doesn't read well to me still. I would say maybe go for

"in a native recipe"

What do you think?

Cheers,
Quentin
Joao Marcos Costa April 9, 2026, 11:22 a.m. UTC | #2
Hello, Quentin

On 4/9/26 12:29, Quentin Schulz via lists.yoctoproject.org wrote:
> Hi João,
> 
> On 4/9/26 11:40 AM, Joao Marcos Costa via lists.yoctoproject.org wrote:
>> Add missing "that" between "recipe" and "inherits".
>>
>> Signed-off-by: João Marcos Costa <joaomarcos.costa@bootlin.com>
>> ---
>>   documentation/ref-manual/variables.rst | 2 +-
>>   1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/documentation/ref-manual/variables.rst 
>> b/documentation/ref-manual/variables.rst
>> index 60e608c0c..8466124e0 100644
>> --- a/documentation/ref-manual/variables.rst
>> +++ b/documentation/ref-manual/variables.rst
>> @@ -1679,7 +1679,7 @@ system and gives an overview of their function 
>> and contents.
>>         .. note::
>> -         When :term:`COMPATIBLE_MACHINE` is set in a recipe inherits 
>> from
>> +         When :term:`COMPATIBLE_MACHINE` is set in a recipe that 
>> inherits from
>>            native, the recipe is always skipped. All native recipes 
>> must be
> 
> Doesn't read well to me still. I would say maybe go for
> 
> "in a native recipe"
> 
> What do you think?
> 
> Cheers,
> Quentin

I like the current phrasing, to be honest. My only concern about it is 
the grammar, so my goal here is to provide a plain fix rather than a 
subjective improvement in semantics.

Thanks for the review!
Quentin Schulz April 9, 2026, 11:32 a.m. UTC | #3
On 4/9/26 1:22 PM, Joao Marcos Costa wrote:
> Hello, Quentin
> 
> On 4/9/26 12:29, Quentin Schulz via lists.yoctoproject.org wrote:
>> Hi João,
>>
>> On 4/9/26 11:40 AM, Joao Marcos Costa via lists.yoctoproject.org wrote:
>>> Add missing "that" between "recipe" and "inherits".
>>>
>>> Signed-off-by: João Marcos Costa <joaomarcos.costa@bootlin.com>
>>> ---
>>>   documentation/ref-manual/variables.rst | 2 +-
>>>   1 file changed, 1 insertion(+), 1 deletion(-)
>>>
>>> diff --git a/documentation/ref-manual/variables.rst b/documentation/ 
>>> ref-manual/variables.rst
>>> index 60e608c0c..8466124e0 100644
>>> --- a/documentation/ref-manual/variables.rst
>>> +++ b/documentation/ref-manual/variables.rst
>>> @@ -1679,7 +1679,7 @@ system and gives an overview of their function 
>>> and contents.
>>>         .. note::
>>> -         When :term:`COMPATIBLE_MACHINE` is set in a recipe inherits 
>>> from
>>> +         When :term:`COMPATIBLE_MACHINE` is set in a recipe that 
>>> inherits from
>>>            native, the recipe is always skipped. All native recipes 
>>> must be
>>
>> Doesn't read well to me still. I would say maybe go for
>>
>> "in a native recipe"
>>
>> What do you think?
>>
>> Cheers,
>> Quentin
> 
> I like the current phrasing, to be honest. My only concern about it is 
> the grammar, so my goal here is to provide a plain fix rather than a 
> subjective improvement in semantics.
> 

inherits from native doesn't mean anything. A recipe can inherit the 
native class, but even then, that's not the only way for a recipe to be 
native, see 
https://docs.yoctoproject.org/ref-manual/classes.html#native. In the 
BBCLASSEXTEND, it'll technically inherit the native class but not via 
the inherit directive.

What matters here is that in the native context of a recipe, 
COMPATIBLE_MACHINE if set will make BitBake skip the native variant of 
the recipe.

Cheers,
Quentin
diff mbox series

Patch

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 60e608c0c..8466124e0 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -1679,7 +1679,7 @@  system and gives an overview of their function and contents.
 
       .. note::
 
-         When :term:`COMPATIBLE_MACHINE` is set in a recipe inherits from
+         When :term:`COMPATIBLE_MACHINE` is set in a recipe that inherits from
          native, the recipe is always skipped. All native recipes must be
          entirely target independent and should not rely on :term:`MACHINE`.