Skip to content

RFC support bitbake blocks

Trevor Woerner yocto-docs 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 RFC Latest2 patches 5 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/2add a "bitbake" pygments lexerdocumentation/conf.py documentation/sphinx/bitbake.py+197 -14 replies
2/2BSP dev guide: update to use bitbake lexerdocumentation/bsp-guide/bsp.rst+30 -100 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [RFC PATCH 0/2] support bitbake blocks

From: Trevor Woerner <[email protected]>

Out of the box, Pygments does not handle bitbake blocks for syntax highlighting. As a result the numerous bitbake examples and snippets throughout our documentation use a basic, non-bitbake-specific highlighting.

This patchset adds a custom lexer to support bitbake syntax, based on the vim syntax highlighting information in [1], adds it to the sphinx extensions, and then goes through the BSP Developer's Guide identifying and re-formatting any bitbake blocks as "..code-block: bitbake".

If this RFC is acceptable, I can update it to convert all such blocks throughout the entire documentation set.

[1] https://git.openembedded.org/bitbake/tree/contrib/vim

Trevor Woerner (2):
add a "bitbake" pygments lexer
BSP dev guide: update to use bitbake lexer

 documentation/bsp-guide/bsp.rst |  40 +++++--
 documentation/conf.py           |   3 +-
 documentation/sphinx/bitbake.py | 195 ++++++++++++++++++++++++++++++++
 3 files changed, 227 insertions(+), 11 deletions(-)
 create mode 100644 documentation/sphinx/bitbake.py
Signature · 1 line
2.50.0.173.g8b6f19ccfc3a