Re: [docs] [PATCH 3/3] brief-yoctoprojectqs/index.rst: switch shell block to to console lexer

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

Hi,

On Fri Nov 28, 2025 at 2:30 PM CET, Quentin Schulz wrote:
> Hi Antonin,
>
> On 11/28/25 2:11 PM, Antonin Godard wrote:
>> Hi,
>> 
>> On Thu Nov 27, 2025 at 5:47 PM CET, Quentin Schulz via lists.yoctoproject.org wrote:
>> [...]
>>>>    #. Choose a configuration (for example, ``poky-master``):
>>>>    
>>>> -   .. code-block:: shell
>>>> +   .. code-block:: console
>>>>    
>>>
>>> Neither shell nor console. I would suggest to simply use a literal block
>>> (::), c.f.
>>> https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#rst-literal-blocks
>> 
>> Thanks, I'll change that.
>> 
>> I just noticed but I think the default lexer for literal blocks is Python unless
>> you explicitly set it to something else in the global configuration[1]. I think
>
> Ah, and I had missed that. I changed it to shell for my company's user 
> manuals but I didn't know it was Python by default (well some sort of 
> Python).
>
>> it makes sense to change it to "text" as the rendering looks odd in most places
>> where it thinks it's Python code, whereas most of the time it's either text
>> snippets or bitbake assignments.
>> 
> I would recommend picking a sensible default. Since there doesn't exist 
> a BitBake lexer (and I don't see a MR for that in pygments) yet, I guess 
> going for "text" or "none" will do. Good catch!
>
> This though will get rid of highlights where it is (to me) somewhat 
> useful, see most blocks in 
> https://docs.yoctoproject.org/ref-manual/variables.html. Maybe it isn't 
> *that* worth it. Up to you.

Yes, re-reading some of the docs I also noticed it would get rid of some useful
highlighting, so I think for text blocks we should use .. code-block:: text when
we think about it. I'll use that for the quick start guide.

Thanks!
Antonin

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