docs/manual/migrating.txt: add section with general migrating tips

This is based on Yann's and Arnout's experience with migrating
Buildroot.

Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
Cc: Yann E. MORIN <yann.morin.1998@free.fr>
[yann.morin.1998@free.fr: add "For more details, "]
Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr>
This commit is contained in:
Arnout Vandecappelle (Essensium/Mind) 2021-08-03 17:44:42 +02:00 committed by Yann E. MORIN
parent a8a9b12766
commit f24fb23829

View File

@ -8,6 +8,36 @@ Some versions have introduced backward incompatibilities. This section
explains those incompatibilities, and for each explains what to do to
complete the migration.
[[migrating-approach]]
=== General approach
To migrate from an older Buildroot version, take the following steps.
. For all your configurations, do a build in the old Buildroot
environment. Run +make graph-size+. Save
+graphs/file-size-stats.csv+ in a different location. Run +make
clean+ to remove the rest.
. Review the specific migration notes below and make the required
adaptations to external packages and custom build scripts.
. Update Buildroot.
. Run +make menuconfig+ starting from the existing +.config+.
. If anything is enabled in the Legacy menu, check its help text,
unselect it, and save the configuration.
. For more details, review the git commit messages for the packages that
you need. Change into the +packages+ directory and run
+git log <old version>.. -- <your packages>+.
. Build in the new Buildroot environment.
. Fix build issues in external packages (usually due to updated
dependencies).
. Run +make graph-size+.
. Compare the new +file-size-stats.csv+ with the original one, to
check if no required files have disappeared and if no new big unneeded
files have appeared.
. For configuration (and other) files in a custom overlay that overwrite
files created by Buildroot, check if there are changes in the
Buildroot-generated file that need to be propagated to your custom
file.
[[br2-external-converting]]
=== Migrating to 2016.11