summaryrefslogtreecommitdiffstats
path: root/documentation/migration-guides/migration-general.rst
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/migration-guides/migration-general.rst')
-rw-r--r--documentation/migration-guides/migration-general.rst14
1 files changed, 7 insertions, 7 deletions
diff --git a/documentation/migration-guides/migration-general.rst b/documentation/migration-guides/migration-general.rst
index c3b8a785db..1820f5cfd8 100644
--- a/documentation/migration-guides/migration-general.rst
+++ b/documentation/migration-guides/migration-general.rst
@@ -76,24 +76,24 @@ any new Yocto Project release.
76 76
77- *Checking Image / SDK Changes*: 77- *Checking Image / SDK Changes*:
78 78
79 The :ref:`buildhistory <ref-classes-buildhistory>` class can be used 79 The :ref:`ref-classes-buildhistory` class can be used
80 if you wish to check the impact of changes to images / SDKs across 80 if you wish to check the impact of changes to images / SDKs across
81 the migration (e.g. added/removed packages, added/removed files, size 81 the migration (e.g. added/removed packages, added/removed files, size
82 changes etc.). To do this, follow these steps: 82 changes etc.). To do this, follow these steps:
83 83
84 #. Enable :ref:`buildhistory <ref-classes-buildhistory>` before the migration 84 #. Enable :ref:`ref-classes-buildhistory` before the migration
85 85
86 #. Run a pre-migration build 86 #. Run a pre-migration build
87 87
88 #. Capture the :ref:`buildhistory <ref-classes-buildhistory>` output (as 88 #. Capture the :ref:`ref-classes-buildhistory` output (as
89 specified by :term:`BUILDHISTORY_DIR`) and ensure it is preserved for 89 specified by :term:`BUILDHISTORY_DIR`) and ensure it is preserved for
90 subsequent builds. How you would do this depends on how you are running 90 subsequent builds. How you would do this depends on how you are running
91 your builds - if you are doing this all on one workstation in the same 91 your builds - if you are doing this all on one workstation in the same
92 :term:`Build Directory` you may not need to do anything other than not 92 :term:`Build Directory` you may not need to do anything other than not
93 deleting the :ref:`buildhistory <ref-classes-buildhistory>` output 93 deleting the :ref:`ref-classes-buildhistory` output
94 directory. For builds in a pipeline it may be more complicated. 94 directory. For builds in a pipeline it may be more complicated.
95 95
96 #. Set a tag in the :ref:`buildhistory <ref-classes-buildhistory>` output (which is a git repository) before 96 #. Set a tag in the :ref:`ref-classes-buildhistory` output (which is a git repository) before
97 migration, to make the commit from the pre-migration build easy to find 97 migration, to make the commit from the pre-migration build easy to find
98 as you may end up running multiple builds during the migration. 98 as you may end up running multiple builds during the migration.
99 99
@@ -102,7 +102,7 @@ any new Yocto Project release.
102 #. Run a build 102 #. Run a build
103 103
104 #. Check the output changes between the previously set tag and HEAD in the 104 #. Check the output changes between the previously set tag and HEAD in the
105 :ref:`buildhistory <ref-classes-buildhistory>` output using ``git diff`` or ``buildhistory-diff``. 105 :ref:`ref-classes-buildhistory` output using ``git diff`` or ``buildhistory-diff``.
106 106
107 For more information on using :ref:`buildhistory <ref-classes-buildhistory>`, see 107 For more information on using :ref:`ref-classes-buildhistory`, see
108 :ref:`dev-manual/build-quality:maintaining build output quality`. 108 :ref:`dev-manual/build-quality:maintaining build output quality`.