diff options
Diffstat (limited to 'documentation/migration-guides/migration-general.rst')
| -rw-r--r-- | documentation/migration-guides/migration-general.rst | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/documentation/migration-guides/migration-general.rst b/documentation/migration-guides/migration-general.rst index 9eecf69af8..1820f5cfd8 100644 --- a/documentation/migration-guides/migration-general.rst +++ b/documentation/migration-guides/migration-general.rst @@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + Introduction ============ @@ -70,3 +72,37 @@ any new Yocto Project release. bitbake-layers show-appends +.. _migration-general-buildhistory: + +- *Checking Image / SDK Changes*: + + The :ref:`ref-classes-buildhistory` class can be used + if you wish to check the impact of changes to images / SDKs across + the migration (e.g. added/removed packages, added/removed files, size + changes etc.). To do this, follow these steps: + + #. Enable :ref:`ref-classes-buildhistory` before the migration + + #. Run a pre-migration build + + #. Capture the :ref:`ref-classes-buildhistory` output (as + specified by :term:`BUILDHISTORY_DIR`) and ensure it is preserved for + subsequent builds. How you would do this depends on how you are running + your builds - if you are doing this all on one workstation in the same + :term:`Build Directory` you may not need to do anything other than not + deleting the :ref:`ref-classes-buildhistory` output + directory. For builds in a pipeline it may be more complicated. + + #. Set a tag in the :ref:`ref-classes-buildhistory` output (which is a git repository) before + migration, to make the commit from the pre-migration build easy to find + as you may end up running multiple builds during the migration. + + #. Perform the migration + + #. Run a build + + #. Check the output changes between the previously set tag and HEAD in the + :ref:`ref-classes-buildhistory` output using ``git diff`` or ``buildhistory-diff``. + + For more information on using :ref:`ref-classes-buildhistory`, see + :ref:`dev-manual/build-quality:maintaining build output quality`. |