[PATCH] migration-guides: 5.3: mention barebox migration guides

[PATCH] migration-guides: 5.3: mention barebox migration guides

[Ahmad Fatoum]

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?
Or given that this would be a recurring aspect for future releases, just
add it once to the class documentation?
---
 documentation/migration-guides/migration-5.3.rst | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/documentation/migration-guides/migration-5.3.rst b/documentation/migration-guides/migration-5.3.rst
index e59bc8c6389a..8ba9cb4f12b6 100644
--- a/documentation/migration-guides/migration-5.3.rst
+++ b/documentation/migration-guides/migration-5.3.rst
@@ -311,3 +311,7 @@ Miscellaneous changes
 
    Recipes currently using the ``fcntl-lock`` command should replace these by
    ``flock --fcntl``.
+
+- ``barebox`` has been updated from v2025.02.0 to v2025.09.0. Refer to the
+  `upstream migration guides <https://barebox.org/doc/latest/migration-guides/>`__
+  for migration advice.
-- 
2.47.3

Re: [docs] [PATCH] migration-guides: 5.3: mention barebox migration guides

[Antonin Godard]

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

Re: [PATCH] migration-guides: 5.3: mention barebox migration guides

[Antonin Godard]

On Thu, 13 Nov 2025 09:55:14 +0100, 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.
> 
> [...]

Applied, thanks!

[1/1] migration-guides: 5.3: mention barebox migration guides
      commit: c059dbf78d8590ad28368a19a9c9234a56ad448c

Best regards,
--