Yocto Project Documentation
 help / color / mirror / Atom feed
From: "Antonin Godard" <antonin.godard@bootlin.com>
To: "Ahmad Fatoum" <a.fatoum@pengutronix.de>, <docs@lists.yoctoproject.org>
Cc: <ejo@pengutronix.de>, <yocto@pengutronix.de>
Subject: Re: [docs] [PATCH] migration-guides: 5.3: mention barebox migration guides
Date: Thu, 13 Nov 2025 10:21:03 +0100	[thread overview]
Message-ID: <DE7GFSIDHHJJ.2MT1342UXUSBA@bootlin.com> (raw)
In-Reply-To: <20251113085516.1067909-1-a.fatoum@pengutronix.de>

Hi,

On Thu Nov 13, 2025 at 9:55 AM CET, Ahmad Fatoum wrote:
> Inspired by the Yocto migration guides in this repository, I have been
> maintaining release migration guides for barebox going back to
> v2024.09.0, the first release after barebox was added to OE-core.
>
> These contain actionable advice for users, e.g., rename of CONFIG options
> or differences in the shell environment.
>
> Reference the barebox migration guides from the Yocto migration guide
> to help users with their updates.
>
> Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
> ---
> Unsure about the placement; Are the release-notes a better place for this?

Given that your link points to a migration document, I think your link is well
placed under the misc changes, thanks. (Also, barebox's version shouldn't change
as we are close to feature freeze).

> Or given that this would be a recurring aspect for future releases, just
> add it once to the class documentation?

I would even just make the class description point to the barebox website:

"""
The :ref:`ref-classes-barebox` class manages building the `barebox
<https://barebox.org>`__ bootloader.
"""

Then a link to the doc / migration document at the end of the class description
could be a good idea too.

Thanks!
Antonin

-- 
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com



  reply	other threads:[~2025-11-13  9:21 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-11-13  8:55 [PATCH] migration-guides: 5.3: mention barebox migration guides Ahmad Fatoum
2025-11-13  9:21 ` Antonin Godard [this message]
2025-11-26 12:51 ` Antonin Godard

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=DE7GFSIDHHJJ.2MT1342UXUSBA@bootlin.com \
    --to=antonin.godard@bootlin.com \
    --cc=a.fatoum@pengutronix.de \
    --cc=docs@lists.yoctoproject.org \
    --cc=ejo@pengutronix.de \
    --cc=yocto@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