[PATCH RESEND] doc: tlv: add images and custom format documentation
Jonas Rebmann
jre at pengutronix.de
Thu Apr 30 05:20:47 PDT 2026
Hi Fabian,
On 2026-04-30 13:41, Fabian Pflug wrote:
> Improve the documentation by adding some images to make the
> interdependencies clearer and add an example on how to define custom TLV
> data format.
I'm not sure if we should track SVGs in version control if they are
machine-generated and contain big base-64 encoded binary blobs.
It can make (rip)grepping e.g. over Documentation quite a pain,
especially given tools will treat them as text files, not binary files,
and will happily dump that 25313-char wide line on the console.
Also, these SVG's aren't really the source of these diagrams. Would it
be easy for someone in the future to adapt them?
Can we turn this into ASCII-art or DOT/Graphviz or similar?
Is there anything our sphinx setup already supports to turn into SVG on
the fly?
Kind regards,
Jonas
--
Pengutronix e.K. | Jonas Rebmann |
Steuerwalder Str. 21 | http://www.pengutronix.de/ |
31137 Hildesheim, Germany | Phone: +49-5121-206917-0 |
Amtsgericht Hildesheim, HRA 2686 | Fax: +49-5121-206917-9 |
More information about the barebox
mailing list