From: Paul Eggleton <paul.eggleton@linux.microsoft.com>
To: docs@lists.yoctoproject.org
Subject: [PATCH 01/34] migration-general: add section on using buildhistory
Date: Mon, 10 Oct 2022 02:23:47 -0700 [thread overview]
Message-ID: <6b333891e6614888bf6de5425db77e7ab856dabe.1665392835.git.paul.eggleton@linux.microsoft.com> (raw)
In-Reply-To: <cover.1665392835.git.paul.eggleton@linux.microsoft.com>
From: Paul Eggleton <paul.eggleton@microsoft.com>
Add a short section recommending the use of buildhistory to compare
the build output before and after migration.
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
---
.../migration-guides/migration-general.rst | 33 ++++++++++++++++++++++
1 file changed, 33 insertions(+)
diff --git a/documentation/migration-guides/migration-general.rst b/documentation/migration-guides/migration-general.rst
index 9eecf69..8b22508 100644
--- a/documentation/migration-guides/migration-general.rst
+++ b/documentation/migration-guides/migration-general.rst
@@ -70,3 +70,36 @@ any new Yocto Project release.
bitbake-layers show-appends
+.. _migration-general-buildhistory:
+
+- *Checking Image / SDK Changes*:
+
+ The :ref:`buildhistory <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:
+
+ 1. Enable buildhistory before the migration
+
+ 2. Run a pre-migration build
+
+ 3. Capture the buildhistory output (as specified by :term:`BUILDHISTORY_DIR`)
+ and ensure it is preserved for subsequent builds. How you would do this
+ depends how you are running your builds - if you are doing this all on
+ one workstation in the same build directory you may not need to do
+ anything other than not deleting the buildhistory output directory. For
+ builds in a pipeline it may be more complicated.
+
+ 4. Set a tag in the 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.
+
+ 5. Perform the migration
+
+ 6. Run a build
+
+ 7. Check the output changes between the previously set tag and HEAD in the
+ buildhistory output using ``git diff`` or ``buildhistory-diff``.
+
+ For more information on using buildhistory, see
+ :ref:`dev-manual/common-tasks:maintaining build output quality`.
--
1.8.3.1
next prev parent reply other threads:[~2022-10-10 9:24 UTC|newest]
Thread overview: 52+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-10-10 9:23 [PATCH 00/34] 4.1 release notes and related changes Paul Eggleton
2022-10-10 9:23 ` Paul Eggleton [this message]
2022-10-11 8:08 ` [docs] [PATCH 01/34] migration-general: add section on using buildhistory Michael Opdenacker
2022-10-10 9:23 ` [PATCH 02/34] ref-manual: add DISABLE_STATIC Paul Eggleton
2022-10-10 9:23 ` [PATCH 03/34] ref-manual: expand documentation on image-buildinfo class Paul Eggleton
2022-10-10 9:23 ` [PATCH 04/34] ref-manual: add WATCHDOG_TIMEOUT to variable glossary Paul Eggleton
2022-10-10 9:23 ` [PATCH 05/34] ref-manual: correct default for BUILDHISTORY_COMMIT Paul Eggleton
2022-10-10 9:23 ` [PATCH 06/34] ref-manual: document new github-releases class Paul Eggleton
2022-10-10 9:23 ` [PATCH 07/34] ref-manual: add a note to ssh-server-dropbear feature Paul Eggleton
2022-10-10 9:23 ` [PATCH 08/34] ref-manual: sync supported distro list with code Paul Eggleton
2022-10-11 8:20 ` [docs] " Michael Opdenacker
2022-10-16 19:16 ` Paul Eggleton
2022-10-17 9:04 ` Michael Opdenacker
2022-10-10 9:23 ` [PATCH 09/34] ref-manual: update buildpaths QA check documentation Paul Eggleton
2022-10-10 9:23 ` [PATCH 10/34] ref-manual: add UBOOT_MKIMAGE_SIGN Paul Eggleton
[not found] ` <10891.1665397447952895356@lists.yoctoproject.org>
2022-10-10 19:37 ` [docs] " Paul Eggleton
2022-10-10 9:23 ` [PATCH 11/34] ref-manual: add DEV_PKG_DEPENDENCY Paul Eggleton
2022-10-10 9:23 ` [PATCH 12/34] ref-manual: add SDK_TOOLCHAIN_LANGS Paul Eggleton
2022-10-10 9:23 ` [PATCH 13/34] ref-manual: add pressure limit variable documentation Paul Eggleton
2022-10-11 10:30 ` [docs] " Michael Opdenacker
2022-10-16 20:38 ` Paul Eggleton
2022-10-17 8:15 ` Michael Opdenacker
2022-10-17 8:26 ` Quentin Schulz
2022-10-17 8:31 ` Michael Opdenacker
2022-10-10 9:24 ` [PATCH 14/34] ref-manual: add pypi class Paul Eggleton
[not found] ` <7844.1665397383974110998@lists.yoctoproject.org>
2022-10-10 19:36 ` [docs] " Paul Eggleton
2022-10-10 9:24 ` [PATCH 15/34] ref-manual: update pypi documentation for CVE_PRODUCT default in 4.1 Paul Eggleton
2022-10-10 9:24 ` [PATCH 16/34] ref-manual: add CVE_CHECK_SHOW_WARNINGS Paul Eggleton
2022-10-10 13:55 ` [docs] " Peter Kjellerstedt
2022-10-10 19:34 ` Paul Eggleton
2022-10-10 9:24 ` [PATCH 17/34] ref-manual: add info on buildtools-make-tarball Paul Eggleton
2022-10-12 9:51 ` [docs] " Michael Opdenacker
2022-10-10 9:24 ` [PATCH 18/34] ref-manual: add FIT_PAD_ALG Paul Eggleton
2022-10-10 9:24 ` [PATCH 19/34] ref-manual: add CVE_DB_UPDATE_INTERVAL Paul Eggleton
2022-10-10 9:24 ` [PATCH 20/34] ref-manual: add KERNEL_DEPLOY_DEPEND Paul Eggleton
2022-10-10 9:24 ` [PATCH 21/34] ref-manual: add MOUNT_BASE variable Paul Eggleton
2022-10-10 9:24 ` [PATCH 22/34] ref-manual: remove reference to testimage-auto class Paul Eggleton
2022-10-10 9:24 ` [PATCH 23/34] Update documentation for classes split Paul Eggleton
2022-10-10 9:24 ` [PATCH 24/34] ref-manual: complementary package installation recommends Paul Eggleton
2022-10-10 9:24 ` [PATCH 25/34] ref-manual: remove reference to largefile in DISTRO_FEATURES Paul Eggleton
2022-10-10 9:24 ` [PATCH 26/34] ref-manual: add missing features Paul Eggleton
2022-10-10 9:24 ` [PATCH 27/34] ref-manual: add serial-autologin-root to IMAGE_FEATURES documentation Paul Eggleton
2022-10-10 9:24 ` [PATCH 28/34] ref-manual: add previous overlayfs-etc variables Paul Eggleton
2022-10-10 9:24 ` [PATCH 29/34] ref-manual: add OVERLAYFS_ETC_EXPOSE_LOWER Paul Eggleton
2022-10-10 9:24 ` [PATCH 30/34] ref-manual: add WIRELESS_DAEMON Paul Eggleton
2022-10-10 9:24 ` [PATCH 31/34] ref-manual: add section for create-spdx class Paul Eggleton
2022-10-10 9:24 ` [PATCH 32/34] ref-manual: add overlayfs class variables Paul Eggleton
2022-10-10 9:24 ` [PATCH 33/34] ref-manual: add OVERLAYFS_QA_SKIP Paul Eggleton
2022-10-10 9:24 ` [PATCH 34/34] Add 4.1 migration guide & release notes Paul Eggleton
2022-10-11 19:31 ` [docs] " Michael Opdenacker
[not found] ` <171D1A9DBE3157A3.17458@lists.yoctoproject.org>
2022-10-12 8:33 ` Michael Opdenacker
[not found] ` <171D4544CA71D54E.3472@lists.yoctoproject.org>
2022-10-12 8:50 ` Michael Opdenacker
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=6b333891e6614888bf6de5425db77e7ab856dabe.1665392835.git.paul.eggleton@linux.microsoft.com \
--to=paul.eggleton@linux.microsoft.com \
--cc=docs@lists.yoctoproject.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox