summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual/upgrading-recipes.rst
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/dev-manual/upgrading-recipes.rst')
-rw-r--r--documentation/dev-manual/upgrading-recipes.rst28
1 files changed, 14 insertions, 14 deletions
diff --git a/documentation/dev-manual/upgrading-recipes.rst b/documentation/dev-manual/upgrading-recipes.rst
index c41e3e1a5d..dd220cc6c8 100644
--- a/documentation/dev-manual/upgrading-recipes.rst
+++ b/documentation/dev-manual/upgrading-recipes.rst
@@ -51,12 +51,12 @@ commit messages in the layer's tree for the changes made to recipes.
51 51
52The following steps describe how to set up the AUH utility: 52The following steps describe how to set up the AUH utility:
53 53
541. *Be Sure the Development Host is Set Up:* You need to be sure that 54#. *Be Sure the Development Host is Set Up:* You need to be sure that
55 your development host is set up to use the Yocto Project. For 55 your development host is set up to use the Yocto Project. For
56 information on how to set up your host, see the 56 information on how to set up your host, see the
57 ":ref:`dev-manual/start:Preparing the Build Host`" section. 57 ":ref:`dev-manual/start:Preparing the Build Host`" section.
58 58
592. *Make Sure Git is Configured:* The AUH utility requires Git to be 59#. *Make Sure Git is Configured:* The AUH utility requires Git to be
60 configured because AUH uses Git to save upgrades. Thus, you must have 60 configured because AUH uses Git to save upgrades. Thus, you must have
61 Git user and email configured. The following command shows your 61 Git user and email configured. The following command shows your
62 configurations:: 62 configurations::
@@ -69,7 +69,7 @@ The following steps describe how to set up the AUH utility:
69 $ git config --global user.name some_name 69 $ git config --global user.name some_name
70 $ git config --global user.email username@domain.com 70 $ git config --global user.email username@domain.com
71 71
723. *Clone the AUH Repository:* To use AUH, you must clone the repository 72#. *Clone the AUH Repository:* To use AUH, you must clone the repository
73 onto your development host. The following command uses Git to create 73 onto your development host. The following command uses Git to create
74 a local copy of the repository on your system:: 74 a local copy of the repository on your system::
75 75
@@ -84,7 +84,7 @@ The following steps describe how to set up the AUH utility:
84 AUH is not part of the :term:`OpenEmbedded-Core (OE-Core)` or 84 AUH is not part of the :term:`OpenEmbedded-Core (OE-Core)` or
85 :term:`Poky` repositories. 85 :term:`Poky` repositories.
86 86
874. *Create a Dedicated Build Directory:* Run the :ref:`structure-core-script` 87#. *Create a Dedicated Build Directory:* Run the :ref:`structure-core-script`
88 script to create a fresh :term:`Build Directory` that you use exclusively 88 script to create a fresh :term:`Build Directory` that you use exclusively
89 for running the AUH utility:: 89 for running the AUH utility::
90 90
@@ -95,7 +95,7 @@ The following steps describe how to set up the AUH utility:
95 recommended as existing settings could cause AUH to fail or behave 95 recommended as existing settings could cause AUH to fail or behave
96 undesirably. 96 undesirably.
97 97
985. *Make Configurations in Your Local Configuration File:* Several 98#. *Make Configurations in Your Local Configuration File:* Several
99 settings are needed in the ``local.conf`` file in the build 99 settings are needed in the ``local.conf`` file in the build
100 directory you just created for AUH. Make these following 100 directory you just created for AUH. Make these following
101 configurations: 101 configurations:
@@ -128,13 +128,13 @@ The following steps describe how to set up the AUH utility:
128 DISTRO_FEATURES:append = " ptest" 128 DISTRO_FEATURES:append = " ptest"
129 129
130 130
1316. *Optionally Start a vncserver:* If you are running in a server 131#. *Optionally Start a vncserver:* If you are running in a server
132 without an X11 session, you need to start a vncserver:: 132 without an X11 session, you need to start a vncserver::
133 133
134 $ vncserver :1 134 $ vncserver :1
135 $ export DISPLAY=:1 135 $ export DISPLAY=:1
136 136
1377. *Create and Edit an AUH Configuration File:* You need to have the 137#. *Create and Edit an AUH Configuration File:* You need to have the
138 ``upgrade-helper/upgrade-helper.conf`` configuration file in your 138 ``upgrade-helper/upgrade-helper.conf`` configuration file in your
139 :term:`Build Directory`. You can find a sample configuration file in the 139 :term:`Build Directory`. You can find a sample configuration file in the
140 :yocto_git:`AUH source repository </auto-upgrade-helper/tree/>`. 140 :yocto_git:`AUH source repository </auto-upgrade-helper/tree/>`.
@@ -346,17 +346,17 @@ you can manually edit the recipe files to upgrade the versions.
346 346
347To manually upgrade recipe versions, follow these general steps: 347To manually upgrade recipe versions, follow these general steps:
348 348
3491. *Change the Version:* Rename the recipe such that the version (i.e. 349#. *Change the Version:* Rename the recipe such that the version (i.e.
350 the :term:`PV` part of the recipe name) 350 the :term:`PV` part of the recipe name)
351 changes appropriately. If the version is not part of the recipe name, 351 changes appropriately. If the version is not part of the recipe name,
352 change the value as it is set for :term:`PV` within the recipe itself. 352 change the value as it is set for :term:`PV` within the recipe itself.
353 353
3542. *Update* :term:`SRCREV` *if Needed*: If the source code your recipe builds 354#. *Update* :term:`SRCREV` *if Needed*: If the source code your recipe builds
355 is fetched from Git or some other version control system, update 355 is fetched from Git or some other version control system, update
356 :term:`SRCREV` to point to the 356 :term:`SRCREV` to point to the
357 commit hash that matches the new version. 357 commit hash that matches the new version.
358 358
3593. *Build the Software:* Try to build the recipe using BitBake. Typical 359#. *Build the Software:* Try to build the recipe using BitBake. Typical
360 build failures include the following: 360 build failures include the following:
361 361
362 - License statements were updated for the new version. For this 362 - License statements were updated for the new version. For this
@@ -377,22 +377,22 @@ To manually upgrade recipe versions, follow these general steps:
377 issues. If a patch is necessary and failing, you need to rebase it 377 issues. If a patch is necessary and failing, you need to rebase it
378 into the new version. 378 into the new version.
379 379
3804. *Optionally Attempt to Build for Several Architectures:* Once you 380#. *Optionally Attempt to Build for Several Architectures:* Once you
381 successfully build the new software for a given architecture, you 381 successfully build the new software for a given architecture, you
382 could test the build for other architectures by changing the 382 could test the build for other architectures by changing the
383 :term:`MACHINE` variable and 383 :term:`MACHINE` variable and
384 rebuilding the software. This optional step is especially important 384 rebuilding the software. This optional step is especially important
385 if the recipe is to be released publicly. 385 if the recipe is to be released publicly.
386 386
3875. *Check the Upstream Change Log or Release Notes:* Checking both these 387#. *Check the Upstream Change Log or Release Notes:* Checking both these
388 reveals if there are new features that could break 388 reveals if there are new features that could break
389 backwards-compatibility. If so, you need to take steps to mitigate or 389 backwards-compatibility. If so, you need to take steps to mitigate or
390 eliminate that situation. 390 eliminate that situation.
391 391
3926. *Optionally Create a Bootable Image and Test:* If you want, you can 392#. *Optionally Create a Bootable Image and Test:* If you want, you can
393 test the new software by booting it onto actual hardware. 393 test the new software by booting it onto actual hardware.
394 394
3957. *Create a Commit with the Change in the Layer Repository:* After all 395#. *Create a Commit with the Change in the Layer Repository:* After all
396 builds work and any testing is successful, you can create commits for 396 builds work and any testing is successful, you can create commits for
397 any changes in the layer holding your upgraded recipe. 397 any changes in the layer holding your upgraded recipe.
398 398