diff options
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/migration-guides/migration-general.rst | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/documentation/migration-guides/migration-general.rst b/documentation/migration-guides/migration-general.rst index 9eecf69af8..0f0408e51f 100644 --- a/documentation/migration-guides/migration-general.rst +++ b/documentation/migration-guides/migration-general.rst | |||
@@ -70,3 +70,36 @@ any new Yocto Project release. | |||
70 | bitbake-layers show-appends | 70 | bitbake-layers show-appends |
71 | 71 | ||
72 | 72 | ||
73 | .. _migration-general-buildhistory: | ||
74 | |||
75 | - *Checking Image / SDK Changes*: | ||
76 | |||
77 | The :ref:`buildhistory <ref-classes-buildhistory>` class can be used | ||
78 | if you wish to check the impact of changes to images / SDKs across | ||
79 | the migration (e.g. added/removed packages, added/removed files, size | ||
80 | changes etc.). To do this, follow these steps: | ||
81 | |||
82 | 1. Enable buildhistory before the migration | ||
83 | |||
84 | 2. Run a pre-migration build | ||
85 | |||
86 | 3. Capture the buildhistory output (as specified by :term:`BUILDHISTORY_DIR`) | ||
87 | and ensure it is preserved for subsequent builds. How you would do this | ||
88 | depends on how you are running your builds - if you are doing this all on | ||
89 | one workstation in the same build directory you may not need to do | ||
90 | anything other than not deleting the buildhistory output directory. For | ||
91 | builds in a pipeline it may be more complicated. | ||
92 | |||
93 | 4. Set a tag in the buildhistory output (which is a git repository) before | ||
94 | migration, to make the commit from the pre-migration build easy to find | ||
95 | as you may end up running multiple builds during the migration. | ||
96 | |||
97 | 5. Perform the migration | ||
98 | |||
99 | 6. Run a build | ||
100 | |||
101 | 7. Check the output changes between the previously set tag and HEAD in the | ||
102 | buildhistory output using ``git diff`` or ``buildhistory-diff``. | ||
103 | |||
104 | For more information on using buildhistory, see | ||
105 | :ref:`dev-manual/common-tasks:maintaining build output quality`. | ||