Re: [docs] [PATCH 00/10] docs: highlight BitBake snippets with the bitbake language

[Quentin Schulz <quentin.schulz@cherry.de>]

Hi Trevor,

On 8/26/26 3:34 AM, Trevor Woerner via lists.yoctoproject.org wrote:
> Pygments 2.21.0 added a BitBake lexer, so BitBake snippets can now say
> what they are instead of rendering as plain literal blocks. This tags
> the ones in yocto-docs.
> 
> One patch per manual, which is also roughly one reviewable unit per
> patch. No prose changes, no reflowing, no reindenting - every hunk turns
> a literal-block introducer into a code-block directive and nothing else.
> 
> Which blocks were converted was decided by reading, not by pattern

"by reading" following a paragraph definitely not written by you and 
with all commits being AI-Generated is quite the stretch ;)

[...]

> Depends on
> ----------
> 
> "docs: state the language of nine literal blocks explicitly", sent

Link to the ML please to make maintainers and reviewers job easier.

[...]

I think this is going the wrong direction. We should actually make 
explicit the language of every :: that is NOT to be understood as 
BitBake code and then make the default highlight language be BitBake. 
The direct benefit is the ability to still backport whatever needs to be 
backported without having to care about the highlight language being 
explicitly bitbake (which won't be available in every branch but 
master). The other benefit is that by default every new code snippet 
will be understood as BitBake syntax, which is very likely what most of 
the snippet should be, and if they aren't, then their language should be 
made explicit. I'm thinking this could also maybe reduce the diff as I'm 
hoping we have more BitBake syntax than shell/python/whatever else so 
maybe easier to review as well. I believe 
https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-highlight_language 
should be the way to do change the default highlight language (according 
to 
https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#literal-blocks 
and 
https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-code-block)?

Cheers,
Quentin