Re: [Buildroot] [PATCH 1/1] package/rpi-firmware: add overlays/README

From: "Yann E. MORIN" <yann.morin.1998@free.fr>
To: Tim Gover <tim.gover@raspberrypi.com>
Cc: buildroot@buildroot.org, Martin Bark <martin@barkynet.com>,
	Mahyar Koshkouei <mahyar.koshkouei@gmail.com>
Subject: Re: [Buildroot] [PATCH 1/1] package/rpi-firmware: add overlays/README
Date: Mon, 31 Oct 2022 14:14:44 +0100	[thread overview]
Message-ID: <20221031131444.GD1058960@scaer> (raw)
In-Reply-To: <CAAvKZ67N24Hj7ejxQ7zueOQbsqq8WNNgLiZauM7GkMHLhN=kYw@mail.gmail.com>

Tim, All,

On 2022-10-31 12:52 +0000, Tim Gover spake thusly:
> On Mon, 31 Oct 2022 at 12:39, Yann E. MORIN <yann.morin.1998@free.fr> wrote:
> > On 2022-10-31 11:46 +0000, Tim Gover spake thusly:
> > > If a custom os_prefix directory is specified then the Raspberry Pi
> > > firmware probes for the README file in overlays directory.
> > > Since the README file is small let's include it, otherwise,
> > 197KiB is _not_ small. In fact, the README is bigger than every dtbo,
> > and accounts for ~25% of the size of all dtbo combined.
> Good point. Would you be happy with simply creating an empty or small
> README file (a note indicating the purpose of the file) ?

Just touching the README should be enough I would say.

> > > the firmware won't recognize the overlays directory if the user
> > > later moves it to an os_prefix specific sub-directory.
> > What is the goal here, in the context of Buildroot, where we only
> > install one set of overlays?
> > If a user moved the overlays, they already have a script that does that,
> > so they should also ensure that script properly prepares config.txt to
> > specify the proper os_prefix, and so it is just a matter of adding a
> > 'touch' on the README in the same script.
> It's fairly common for non-expert users to modify the output of a
> buildroot image
> without re-building the image themselves. Adding a README file reduces
> the risk of them being tripped up by this difference in behaviour.

So, if I read you correctly: non-expert users know they can move the
overlays to a sub-dir; they also know they have to set the os_prefix
accordingly in config.txt; but they don't know they have to create a
README in there? ;-)

Sorry, I am still unconvinced.

Regards,
Yann E. MORIN.

-- 
.-----------------.--------------------.------------------.--------------------.
|  Yann E. MORIN  | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: |
| +33 662 376 056 | Software  Designer | \ / CAMPAIGN     |  ___               |
| +33 561 099 427 `------------.-------:  X  AGAINST      |  \e/  There is no  |
| http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL    |   v   conspiracy.  |
'------------------------------^-------^------------------^--------------------'
_______________________________________________
buildroot mailing list
buildroot@buildroot.org
https://lists.buildroot.org/mailman/listinfo/buildroot