diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2023-01-05 08:34:26 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2023-01-06 17:39:09 +0000 |
commit | 8b1909aa6f7a51a878dc3d4a9223403ad3e164a9 (patch) | |
tree | e1418f545ad6640afb5fde004696eef2a9e6e67b /documentation/migration-guides/migration-general.rst | |
parent | ae280972ffba62d7ed839b692957f61b0955cbca (diff) | |
download | poky-8b1909aa6f7a51a878dc3d4a9223403ad3e164a9.tar.gz |
manuals: simplify references to classes
Now that .bbclass is removed from class section titles.
We can now have, for example, :ref:`ref-classes-insane`
instead of :ref:`insane <ref-classes-insane>`.
Then, when necessary, rework paragraphs so that they
have lines of even length, not exceeding 80 characters.
(From yocto-docs rev: e76190e3be78c1e483bec0469f1e437dbf8f3791)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Suggested-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/migration-guides/migration-general.rst')
-rw-r--r-- | documentation/migration-guides/migration-general.rst | 14 |
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`. |