diff options
| -rw-r--r-- | documentation/migration-guides/migration-general.rst | 26 |
1 files changed, 22 insertions, 4 deletions
diff --git a/documentation/migration-guides/migration-general.rst b/documentation/migration-guides/migration-general.rst index 182482ec43..9eecf69af8 100644 --- a/documentation/migration-guides/migration-general.rst +++ b/documentation/migration-guides/migration-general.rst | |||
| @@ -1,5 +1,17 @@ | |||
| 1 | Introduction | ||
| 2 | ============ | ||
| 3 | |||
| 4 | This guide provides a list of the backwards-incompatible changes you | ||
| 5 | might need to adapt to in your existing Yocto Project configuration | ||
| 6 | when upgrading to a new release. | ||
| 7 | |||
| 8 | If you are upgrading over multiple releases, you will need to follow | ||
| 9 | the sections from the version following the one you were previously | ||
| 10 | using up to the new version you are upgrading to. | ||
| 11 | |||
| 12 | |||
| 1 | General Migration Considerations | 13 | General Migration Considerations |
| 2 | ================================ | 14 | -------------------------------- |
| 3 | 15 | ||
| 4 | Some considerations are not tied to a specific Yocto Project release. | 16 | Some considerations are not tied to a specific Yocto Project release. |
| 5 | This section presents information you should consider when migrating to | 17 | This section presents information you should consider when migrating to |
| @@ -26,16 +38,17 @@ any new Yocto Project release. | |||
| 26 | 38 | ||
| 27 | The better solution (where practical) is to use append files | 39 | The better solution (where practical) is to use append files |
| 28 | (``*.bbappend``) to capture any customizations you want to make to a | 40 | (``*.bbappend``) to capture any customizations you want to make to a |
| 29 | recipe. Doing so, isolates your changes from the main recipe making | 41 | recipe. Doing so isolates your changes from the main recipe, making |
| 30 | them much more manageable. However, sometimes it is not practical to | 42 | them much more manageable. However, sometimes it is not practical to |
| 31 | use an append file. A good example of this is when introducing a | 43 | use an append file. A good example of this is when introducing a |
| 32 | newer or older version of a recipe in another layer. | 44 | newer or older version of a recipe in another layer. |
| 33 | 45 | ||
| 46 | |||
| 34 | - *Updating Append Files*: | 47 | - *Updating Append Files*: |
| 35 | 48 | ||
| 36 | Since append files generally only contain | 49 | Since append (``.bbappend``) files generally only contain |
| 37 | your customizations, they often do not need to be adjusted for new | 50 | your customizations, they often do not need to be adjusted for new |
| 38 | releases. However, if the ``.bbappend`` file is specific to a | 51 | releases. However, if the append file is specific to a |
| 39 | particular version of the recipe (i.e. its name does not use the % | 52 | particular version of the recipe (i.e. its name does not use the % |
| 40 | wildcard) and the version of the recipe to which it is appending has | 53 | wildcard) and the version of the recipe to which it is appending has |
| 41 | changed, then you will at a minimum need to rename the append file to | 54 | changed, then you will at a minimum need to rename the append file to |
| @@ -50,5 +63,10 @@ any new Yocto Project release. | |||
| 50 | this is the case and assuming the patch is still needed, you must | 63 | this is the case and assuming the patch is still needed, you must |
| 51 | modify the patch file so that it does apply. | 64 | modify the patch file so that it does apply. |
| 52 | 65 | ||
| 66 | .. tip:: | ||
| 67 | |||
| 68 | You can list all append files used in your configuration by running: | ||
| 69 | |||
| 70 | bitbake-layers show-appends | ||
| 53 | 71 | ||
| 54 | 72 | ||