Yocto Project Documentation
 help / color / mirror / Atom feed
From: "Antonin Godard" <antonin.godard@bootlin.com>
To: "Quentin Schulz" <quentin.schulz@cherry.de>,
	"Trevor Woerner" <twoerner@gmail.com>
Cc: <docs@lists.yoctoproject.org>
Subject: Re: [docs] [PATCH 00/10] docs: highlight BitBake snippets with the bitbake language
Date: Mon, 31 Aug 2026 11:01:44 +0200	[thread overview]
Message-ID: <DL309JI7KO5S.31U2Y9LIHSH9Q@bootlin.com> (raw)
In-Reply-To: <121fe43e-bdec-4f2b-9f54-e92dfa887e33@cherry.de>

Hi Quentin, Trevor,

After having thought about this a bit more, I think there are pros and cons to
both approaches, but I'm leaning towards Quentin's approach. The other approach
may feel "safe", and doesn't leave room to errors, but I'm afraid that 1. most
contributors will forget about it and 2. it might make the process more painful
for them.

So here what we should do:

- set `hightlight_language = "bitbake"` in conf.py.

- remove file-wide lexer enforcing (.. highlight:: directive at the top of the
  file) (in a separate patch)

- use the appropriate lexer for each code-block that is _not_ bitbake code.

- fix any parsing error from the bitbake lexer (I did have some when trying it).
  If this happens, use "none" and *add a identifiable comment* above it to
  explain that there's an issue with the lexer. This way we can track them and
  fix them when Pygments gets an update.

- document this way of proceeding in standards.md.

If you think of anything else we should do here, please share your thoughts :)

Trevor, if you want to send another version of your series, please rebase on
*master-next* as it contains cleanups to the conf.py file at the moment (+ some
possible additional code-blocks).

Thanks both for sharing your thoughts on this!

Antonin


  reply	other threads:[~2026-08-31  9:01 UTC|newest]

Thread overview: 33+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-08-26  1:34 [PATCH 00/10] docs: highlight BitBake snippets with the bitbake language Trevor Woerner
2026-08-26  1:34 ` [PATCH 01/10] ref-manual/variables.rst: use the bitbake code-block language Trevor Woerner
2026-08-26  1:34 ` [PATCH 02/10] ref-manual: " Trevor Woerner
2026-08-26  1:34 ` [PATCH 03/10] dev-manual: " Trevor Woerner
2026-08-26  1:34 ` [PATCH 04/10] migration-guides: " Trevor Woerner
2026-08-26  1:34 ` [PATCH 05/10] kernel-dev: " Trevor Woerner
2026-08-26  1:34 ` [PATCH 06/10] test-manual: " Trevor Woerner
2026-08-26  1:34 ` [PATCH 07/10] overview-manual: " Trevor Woerner
2026-08-26  1:34 ` [PATCH 08/10] security-manual: " Trevor Woerner
2026-08-26  1:34 ` [PATCH 09/10] sdk-manual: " Trevor Woerner
2026-08-26  1:34 ` [PATCH 10/10] docs-wide: " Trevor Woerner
2026-08-26 11:56 ` [PATCH 00/10] docs: highlight BitBake snippets with the bitbake language Paul Barker
2026-08-26 13:29   ` Trevor Woerner
2026-08-26 12:10 ` [docs] " Quentin Schulz
2026-08-26 13:09   ` Antonin Godard
2026-08-26 13:25     ` Trevor Woerner
2026-08-26 14:45       ` Quentin Schulz
2026-08-26 19:56         ` Trevor Woerner
2026-08-27 14:33           ` Quentin Schulz
2026-08-31  9:01             ` Antonin Godard [this message]
2026-08-31 13:18               ` Trevor Woerner
2026-08-31 14:16               ` Trevor Woerner
2026-08-31 15:19                 ` Antonin Godard
2026-08-31 15:55                   ` Trevor Woerner
2026-09-01  7:31                     ` Antonin Godard
2026-08-26 14:34     ` Quentin Schulz
2026-08-26 15:10       ` Antonin Godard
2026-08-26 15:43         ` Quentin Schulz
2026-08-27  8:02           ` Antonin Godard
2026-08-27  8:38 ` Antonin Godard
2026-08-27 11:34   ` Trevor Woerner
2026-08-27 12:16     ` Antonin Godard
2026-08-27 14:23       ` Quentin Schulz

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=DL309JI7KO5S.31U2Y9LIHSH9Q@bootlin.com \
    --to=antonin.godard@bootlin.com \
    --cc=docs@lists.yoctoproject.org \
    --cc=quentin.schulz@cherry.de \
    --cc=twoerner@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox