Re: [OE-core] [PATCH v4 2/7] barebox-tools: add initial barebox tools support

Enrico Jörns
2024-09-10T09:33:03Z

Am Dienstag, dem 10.09.2024 um 11:22 +0200 schrieb Alexander Kanavin:
> On Tue, 10 Sept 2024 at 11:02, Enrico Jörns <ejo@pengutronix.de> wrote:
> > My impression was that the actual amount of things to share would not justify another file.
> > It is mainly license information, SRC_URI and a bit of metadata where I found it more obvious to
> > have them in the respective recipe.
> >
> > If having shared parts in a barebox-common.inc is actually preferable, I could rework this of
> > course.
>
> It is yes. They are the same between recipes, and so should be specified once.
>
> > > Also there should be a good DESCRIPTION in there. Why
> > > barebox, and not u-boot, for example?
> >
> > Trying to outdo other projects was not my intention.
> > So I would like to omit such comparisons from the description.

ok, will do.

> > My current summary:
> >
> >   "barebox is a bootloader designed for embedded systems.
> >   It runs on a variety of architectures including x86, ARM, MIPS, PowerPC and others."
> >
> > does not yet get the point of a bootloader?
> > I also thought that adding too much information would make the summary too long.
> > But in case something important is missing, I am open to further suggestions.
>
> There's a SUMMARY (which is ok), but there's no DESCRIPTION, and they
> are two different texts. We do require a DESCRIPTION that contains a
> paragraph or two, with multiple sentences that properly introduce the
> project. You don't have to directly compare to u-boot, but you do need
> to highlight the best features and advantages of the component. Being
> terse or generic in DESCRIPTION is not a good thing, and no
> DESCRIPTION at all is even worse.

Sorry, maybe I got confused since the SUMMARY I had is as long as other recipes DESCRIPTION.
But you're right, it's not the same and the DESCRIPTION is missing.
My understanding so far was that SUMMARY is mandatory while DESCRIPTION isn't.
However having one is better than not having one.

I'll attempt to provide a more comprehensive DESCRIPTION.

Regards, Enrico

> Alex
>

--
Pengutronix e.K.                           | Enrico Jörns                |
Embedded Linux Consulting & Support        | https://www.pengutronix.de/ |
Steuerwalder Str. 21                       | Phone: +49-5121-206917-180  |
31137 Hildesheim, Germany                  | Fax:   +49-5121-206917-9    |