Re: [docs] qemuboot.conf variables

[Mark Hatle <mark.hatle@kernel.crashing.org>]

On 2/17/25 6:04 AM, Quentin Schulz via lists.yoctoproject.org wrote:
> Hi Mark,
> 
> On 2/14/25 4:50 PM, Mark Hatle via lists.yoctoproject.org wrote:
>> When I was looking through the large docs, I didn't see anything inside
>> of it to explain the various variables used in the qemuboot.conf file.
>>
>> Looking through the code, I found the stuff mostly in the class that
>> creates the file, but there were also fragments of explanation in prior
>> commit messages and other places.  Below is my attempt to collect all of
>> the qemuboot.conf variables in one place, along with an explanation.  I
>> think this would be useful to add to the regular docs, but I'm not
>> exactly sure where or what format.
>>
> 
> We do have a QEMU-specific document so that could be a start though we
> don't have a glossary in there so we wouldn't be able to :term:`QB_DTB`
> for example elsewhere in the docs.
> 
> Another option is to have them all in the variables glossary with other
> variables. They may be a bit too machine-specific to be there, but maybe
> that's fine. In short, I don't know either what would be best. We could
> start with documentation/dev-manual/qemu.rst in any case.

I think a qemu specific document or section would be my suggested.  There is a 
lot of stuff about runqemu that is documented in the code or in random places 
and it would be nice to move it all to one place.

>> There are some other things related to runqemu usage that would be nice
>> to document as well (command line usage, environment variable, command
> 
> We do have a section on the command line options for runqemu, are you
> thinking about something different?

This is only a small part.  There are environment variables and how they are 
used, substitutions such as @PORT@ and others that are applied to certain parts 
of the configuration, etc.  Each of these really should be documented.

>> substitution behavior and generated command line rules), but the items
>> below are the ones that I had to search for when I was trying to explain
>> the qemuboot.conf to someone else.
>>
> 
> Thanks for sharing the info with us, looking forward to having patches
> on the mailing list :)
> 
> Cheers,
> Quentin
> 
> 
> 
> -=-=-=-=-=-=-=-=-=-=-=-
> Links: You receive all messages sent to this group.
> View/Reply Online (#6382): https://lists.yoctoproject.org/g/docs/message/6382
> Mute This Topic: https://lists.yoctoproject.org/mt/111184281/3616948
> Group Owner: docs+owner@lists.yoctoproject.org
> Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [mark.hatle@kernel.crashing.org]
> -=-=-=-=-=-=-=-=-=-=-=-
>