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

["Antonin Godard" <antonin.godard@bootlin.com>]

Hi,

On Wed Aug 26, 2026 at 2:10 PM CEST, Quentin Schulz via lists.yoctoproject.org wrote:
> 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. 

But then this might get forgotten? How about having the default highlighted as
"none", and make _everything_ use explicit code-blocks?

Sure, this is more efforts and review time, but also this is how other markup
languages work - like markdown, where by default (when using ```...```) no
syntax highlighting is done.

This is maybe a more conservative approach but at least it doesn't leave room
for code blocks mistakenly highlighted with the bitbake lexer.

Antonin