should variables glossary document REQUIRED_MACHINE_FEATURES and a bunch more?

should variables glossary document REQUIRED_MACHINE_FEATURES and a bunch more?

[Robert P. J. Day]

  here:

https://docs.yoctoproject.org/ref-manual/classes.html#features-check

the majority of that bullet list of variables does not contain links
to the variables glossary, simply because those variables are not *in*
the variables glossary. should they be?

rday

Re: [docs] should variables glossary document REQUIRED_MACHINE_FEATURES and a bunch more?

[Quentin Schulz]

Hi Robert,

On 11/18/25 4:43 PM, Robert P. J. Day via lists.yoctoproject.org wrote:
> 
>    here:
> 
> https://docs.yoctoproject.org/ref-manual/classes.html#features-check
> 
> the majority of that bullet list of variables does not contain links
> to the variables glossary, simply because those variables are not *in*
> the variables glossary. should they be?
> 

If those variables are still used in master, they should be documented. 
If they aren't, they should be removed. One exception is the migration 
manual where we cannot have links in older versions of docs for the 
glossary, so there are old variables that aren't in master anymore but 
are kept.

Cheers,
Quentin

Re: [docs] should variables glossary document REQUIRED_MACHINE_FEATURES and a bunch more?

[Antonin Godard]

Hi,

On Tue Nov 18, 2025 at 4:43 PM CET, Robert P. J. Day wrote:
>
>   here:
>
> https://docs.yoctoproject.org/ref-manual/classes.html#features-check
>
> the majority of that bullet list of variables does not contain links
> to the variables glossary, simply because those variables are not *in*
> the variables glossary. should they be?

I documented the missing REQUIRED_* variables recently, so these could be
updated to add the cross-ref to the glossary.

Patches for the remaining undocumented variables welcome!

Thanks,
Antonin

-- 
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com