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.rst21
1 files changed, 11 insertions, 10 deletions
diff --git a/documentation/migration-guides/migration-general.rst b/documentation/migration-guides/migration-general.rst
index 847bdad739..8503017580 100644
--- a/documentation/migration-guides/migration-general.rst
+++ b/documentation/migration-guides/migration-general.rst
@@ -79,18 +79,19 @@ any new Yocto Project release.
79 the migration (e.g. added/removed packages, added/removed files, size 79 the migration (e.g. added/removed packages, added/removed files, size
80 changes etc.). To do this, follow these steps: 80 changes etc.). To do this, follow these steps:
81 81
82 1. Enable buildhistory before the migration 82 1. Enable :ref:`buildhistory <ref-classes-buildhistory>` before the migration
83 83
84 2. Run a pre-migration build 84 2. Run a pre-migration build
85 85
86 3. Capture the buildhistory output (as specified by :term:`BUILDHISTORY_DIR`) 86 3. Capture the :ref:`buildhistory <ref-classes-buildhistory>` output (as
87 and ensure it is preserved for subsequent builds. How you would do this 87 specified by :term:`BUILDHISTORY_DIR`) and ensure it is preserved for
88 depends on how you are running your builds - if you are doing this all on 88 subsequent builds. How you would do this depends on how you are running
89 one workstation in the same :term:`Build Directory` you may not need to do 89 your builds - if you are doing this all on one workstation in the same
90 anything other than not deleting the buildhistory output directory. For 90 :term:`Build Directory` you may not need to do anything other than not
91 builds in a pipeline it may be more complicated. 91 deleting the :ref:`buildhistory <ref-classes-buildhistory>` output
92 directory. For builds in a pipeline it may be more complicated.
92 93
93 4. Set a tag in the buildhistory output (which is a git repository) before 94 4. Set a tag in the :ref:`buildhistory <ref-classes-buildhistory>` output (which is a git repository) before
94 migration, to make the commit from the pre-migration build easy to find 95 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 as you may end up running multiple builds during the migration.
96 97
@@ -99,7 +100,7 @@ any new Yocto Project release.
99 6. Run a build 100 6. Run a build
100 101
101 7. Check the output changes between the previously set tag and HEAD in the 102 7. Check the output changes between the previously set tag and HEAD in the
102 buildhistory output using ``git diff`` or ``buildhistory-diff``. 103 :ref:`buildhistory <ref-classes-buildhistory>` output using ``git diff`` or ``buildhistory-diff``.
103 104
104 For more information on using buildhistory, see 105 For more information on using :ref:`buildhistory <ref-classes-buildhistory>`, see
105 :ref:`dev-manual/common-tasks:maintaining build output quality`. 106 :ref:`dev-manual/common-tasks:maintaining build output quality`.