mail archive of the barebox mailing list
 help / color / mirror / Atom feed
From: Jonas Rebmann <jre@pengutronix.de>
To: Fabian Pflug <f.pflug@pengutronix.de>,
	Sascha Hauer <s.hauer@pengutronix.de>,
	BAREBOX <barebox@lists.infradead.org>
Subject: Re: [PATCH RESEND] doc: tlv: add images and custom format documentation
Date: Thu, 30 Apr 2026 14:20:47 +0200	[thread overview]
Message-ID: <193581a7-fd26-4ac4-b6a0-b625c8090f2e@pengutronix.de> (raw)
In-Reply-To: <20260430-v2026-04-0-topic-tlv-doc-v1-1-5aa0ef602bb8@pengutronix.de>

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    |



  reply	other threads:[~2026-04-30 12:21 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-04-30 11:41 Fabian Pflug
2026-04-30 12:20 ` Jonas Rebmann [this message]
2026-04-30 14:41   ` Jonas Rebmann

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=193581a7-fd26-4ac4-b6a0-b625c8090f2e@pengutronix.de \
    --to=jre@pengutronix.de \
    --cc=barebox@lists.infradead.org \
    --cc=f.pflug@pengutronix.de \
    --cc=s.hauer@pengutronix.de \
    /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