summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2023-10-23 21:26:44 +0200
committerSteve Sakoman <steve@sakoman.com>2023-10-25 04:45:51 -1000
commitaaf748b95f62621d1139c62c40e418c272cc6a63 (patch)
treef858b74d30a565002e5ecf36c5dacf56b5f864e0
parent811cf0320c251f3667109ab99695d6694a30ecd3 (diff)
downloadpoky-aaf748b95f62621d1139c62c40e418c272cc6a63.tar.gz
manuals: update linux-yocto append examples
(From yocto-docs rev: b5d385f20d22566e12a7938a9894b86429f1dcfb) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
-rw-r--r--documentation/bsp-guide/bsp.rst32
-rw-r--r--documentation/kernel-dev/advanced.rst3
-rw-r--r--documentation/kernel-dev/common.rst34
-rw-r--r--documentation/ref-manual/variables.rst12
4 files changed, 40 insertions, 41 deletions
diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst
index 8b29290b59..f9e13d145a 100644
--- a/documentation/bsp-guide/bsp.rst
+++ b/documentation/bsp-guide/bsp.rst
@@ -1449,39 +1449,39 @@ The kernel recipe used to build the kernel image for the BeagleBone
1449device was established in the machine configuration:: 1449device was established in the machine configuration::
1450 1450
1451 PREFERRED_PROVIDER_virtual/kernel ?= "linux-yocto" 1451 PREFERRED_PROVIDER_virtual/kernel ?= "linux-yocto"
1452 PREFERRED_VERSION_linux-yocto ?= "5.0%" 1452 PREFERRED_VERSION_linux-yocto ?= "5.15%"
1453 1453
1454The ``meta-yocto-bsp/recipes-kernel/linux`` directory in the layer contains 1454The ``meta-yocto-bsp/recipes-kernel/linux`` directory in the layer contains
1455metadata used to build the kernel. In this case, a kernel append file 1455metadata used to build the kernel. In this case, a kernel append file
1456(i.e. ``linux-yocto_5.0.bbappend``) is used to override an established 1456(i.e. ``linux-yocto_5.15.bbappend``) is used to override an established
1457kernel recipe (i.e. ``linux-yocto_5.0.bb``), which is located in 1457kernel recipe (i.e. ``linux-yocto_5.15.bb``), which is located in
1458:yocto_git:`/poky/tree/meta/recipes-kernel/linux`. 1458:yocto_git:`/poky/tree/meta-yocto-bsp/recipes-kernel/linux`.
1459 1459
1460Following is the contents of the append file:: 1460Following is the contents of the append file::
1461 1461
1462 KBRANCH:genericx86 = "v5.0/standard/base" 1462 KBRANCH:genericx86 = "v5.15/standard/base"
1463 KBRANCH:genericx86-64 = "v5.0/standard/base" 1463 KBRANCH:genericx86-64 = "v5.15/standard/base"
1464 KBRANCH:edgerouter = "v5.0/standard/edgerouter" 1464 KBRANCH:edgerouter = "v5.15/standard/edgerouter"
1465 KBRANCH:beaglebone-yocto = "v5.0/standard/beaglebone" 1465 KBRANCH:beaglebone-yocto = "v5.15/standard/beaglebone"
1466 1466
1467 KMACHINE:genericx86 ?= "common-pc" 1467 KMACHINE:genericx86 ?= "common-pc"
1468 KMACHINE:genericx86-64 ?= "common-pc-64" 1468 KMACHINE:genericx86-64 ?= "common-pc-64"
1469 KMACHINE:beaglebone-yocto ?= "beaglebone" 1469 KMACHINE:beaglebone-yocto ?= "beaglebone"
1470 1470
1471 SRCREV_machine:genericx86 ?= "3df4aae6074e94e794e27fe7f17451d9353cdf3d" 1471 SRCREV_machine:genericx86 ?= "0b628306d1f9ea28c0e86369ce9bb87a47893c9c"
1472 SRCREV_machine:genericx86-64 ?= "3df4aae6074e94e794e27fe7f17451d9353cdf3d" 1472 SRCREV_machine:genericx86-64 ?= "0b628306d1f9ea28c0e86369ce9bb87a47893c9c"
1473 SRCREV_machine:edgerouter ?= "3df4aae6074e94e794e27fe7f17451d9353cdf3d" 1473 SRCREV_machine:edgerouter ?= "90f1ee6589264545f548d731c2480b08a007230f"
1474 SRCREV_machine:beaglebone-yocto ?= "3df4aae6074e94e794e27fe7f17451d9353cdf3d" 1474 SRCREV_machine:beaglebone-yocto ?= "9aabbaa89fcb21af7028e814c1f5b61171314d5a"
1475 1475
1476 COMPATIBLE_MACHINE:genericx86 = "genericx86" 1476 COMPATIBLE_MACHINE:genericx86 = "genericx86"
1477 COMPATIBLE_MACHINE:genericx86-64 = "genericx86-64" 1477 COMPATIBLE_MACHINE:genericx86-64 = "genericx86-64"
1478 COMPATIBLE_MACHINE:edgerouter = "edgerouter" 1478 COMPATIBLE_MACHINE:edgerouter = "edgerouter"
1479 COMPATIBLE_MACHINE:beaglebone-yocto = "beaglebone-yocto" 1479 COMPATIBLE_MACHINE:beaglebone-yocto = "beaglebone-yocto"
1480 1480
1481 LINUX_VERSION:genericx86 = "5.0.3" 1481 LINUX_VERSION:genericx86 = "5.15.72"
1482 LINUX_VERSION:genericx86-64 = "5.0.3" 1482 LINUX_VERSION:genericx86-64 = "5.15.72"
1483 LINUX_VERSION:edgerouter = "5.0.3" 1483 LINUX_VERSION:edgerouter = "5.15.54"
1484 LINUX_VERSION:beaglebone-yocto = "5.0.3" 1484 LINUX_VERSION:beaglebone-yocto = "5.15.54"
1485 1485
1486This particular append file works for all the machines that are 1486This particular append file works for all the machines that are
1487part of the ``meta-yocto-bsp`` layer. The relevant statements are 1487part of the ``meta-yocto-bsp`` layer. The relevant statements are
diff --git a/documentation/kernel-dev/advanced.rst b/documentation/kernel-dev/advanced.rst
index b5290b61b3..e38a8da25c 100644
--- a/documentation/kernel-dev/advanced.rst
+++ b/documentation/kernel-dev/advanced.rst
@@ -69,8 +69,7 @@ to indicate the branch.
69 You can use the :term:`KBRANCH` value to define an alternate branch typically 69 You can use the :term:`KBRANCH` value to define an alternate branch typically
70 with a machine override as shown here from the ``meta-yocto-bsp`` layer:: 70 with a machine override as shown here from the ``meta-yocto-bsp`` layer::
71 71
72 KBRANCH:edgerouter = "standard/edgerouter" 72 KBRANCH:beaglebone-yocto = "standard/beaglebone"
73
74 73
75The linux-yocto style recipes can optionally define the following 74The linux-yocto style recipes can optionally define the following
76variables: 75variables:
diff --git a/documentation/kernel-dev/common.rst b/documentation/kernel-dev/common.rst
index 4279cbb707..3406fcfe75 100644
--- a/documentation/kernel-dev/common.rst
+++ b/documentation/kernel-dev/common.rst
@@ -455,13 +455,13 @@ Creating the Append File
455 455
456You create this file in your custom layer. You also name it accordingly 456You create this file in your custom layer. You also name it accordingly
457based on the linux-yocto recipe you are using. For example, if you are 457based on the linux-yocto recipe you are using. For example, if you are
458modifying the ``meta/recipes-kernel/linux/linux-yocto_4.12.bb`` recipe, 458modifying the ``meta/recipes-kernel/linux/linux-yocto_5.15.bb`` recipe,
459the append file will typically be located as follows within your custom 459the append file will typically be located as follows within your custom
460layer: 460layer:
461 461
462.. code-block:: none 462.. code-block:: none
463 463
464 your-layer/recipes-kernel/linux/linux-yocto_4.12.bbappend 464 your-layer/recipes-kernel/linux/linux-yocto_5.15.bbappend
465 465
466The append file should initially extend the 466The append file should initially extend the
467:term:`FILESPATH` search path by 467:term:`FILESPATH` search path by
@@ -489,36 +489,36 @@ As an example, consider the following append file used by the BSPs in
489 489
490.. code-block:: none 490.. code-block:: none
491 491
492 meta-yocto-bsp/recipes-kernel/linux/linux-yocto_4.12.bbappend 492 meta-yocto-bsp/recipes-kernel/linux/linux-yocto_5.15.bbappend
493 493
494Here are the contents of this file. Be aware that the actual commit ID 494Here are the contents of this file. Be aware that the actual commit ID
495strings in this example listing might be different than the actual 495strings in this example listing might be different than the actual
496strings in the file from the ``meta-yocto-bsp`` layer upstream. 496strings in the file from the ``meta-yocto-bsp`` layer upstream.
497:: 497::
498 498
499 KBRANCH:genericx86 = "standard/base" 499 KBRANCH:genericx86 = "v5.15/standard/base"
500 KBRANCH:genericx86-64 = "standard/base" 500 KBRANCH:genericx86-64 = "v5.15/standard/base"
501 KBRANCH:edgerouter = "v5.15/standard/edgerouter"
502 KBRANCH:beaglebone-yocto = "v5.15/standard/beaglebone"
501 503
502 KMACHINE:genericx86 ?= "common-pc" 504 KMACHINE:genericx86 ?= "common-pc"
503 KMACHINE:genericx86-64 ?= "common-pc-64" 505 KMACHINE:genericx86-64 ?= "common-pc-64"
504 KBRANCH:edgerouter = "standard/edgerouter" 506 KMACHINE:beaglebone-yocto ?= "beaglebone"
505 KBRANCH:beaglebone = "standard/beaglebone"
506
507 SRCREV_machine:genericx86 ?= "d09f2ce584d60ecb7890550c22a80c48b83c2e19"
508 SRCREV_machine:genericx86-64 ?= "d09f2ce584d60ecb7890550c22a80c48b83c2e19"
509 SRCREV_machine:edgerouter ?= "b5c8cfda2dfe296410d51e131289fb09c69e1e7d"
510 SRCREV_machine:beaglebone ?= "b5c8cfda2dfe296410d51e131289fb09c69e1e7d"
511 507
508 SRCREV_machine:genericx86 ?= "0b628306d1f9ea28c0e86369ce9bb87a47893c9c"
509 SRCREV_machine:genericx86-64 ?= "0b628306d1f9ea28c0e86369ce9bb87a47893c9c"
510 SRCREV_machine:edgerouter ?= "90f1ee6589264545f548d731c2480b08a007230f"
511 SRCREV_machine:beaglebone-yocto ?= "9aabbaa89fcb21af7028e814c1f5b61171314d5a"
512 512
513 COMPATIBLE_MACHINE:genericx86 = "genericx86" 513 COMPATIBLE_MACHINE:genericx86 = "genericx86"
514 COMPATIBLE_MACHINE:genericx86-64 = "genericx86-64" 514 COMPATIBLE_MACHINE:genericx86-64 = "genericx86-64"
515 COMPATIBLE_MACHINE:edgerouter = "edgerouter" 515 COMPATIBLE_MACHINE:edgerouter = "edgerouter"
516 COMPATIBLE_MACHINE:beaglebone = "beaglebone" 516 COMPATIBLE_MACHINE:beaglebone-yocto = "beaglebone-yocto"
517 517
518 LINUX_VERSION:genericx86 = "4.12.7" 518 LINUX_VERSION:genericx86 = "5.15.72"
519 LINUX_VERSION:genericx86-64 = "4.12.7" 519 LINUX_VERSION:genericx86-64 = "5.15.72"
520 LINUX_VERSION:edgerouter = "4.12.10" 520 LINUX_VERSION:edgerouter = "5.15.54"
521 LINUX_VERSION:beaglebone = "4.12.10" 521 LINUX_VERSION:beaglebone-yocto = "5.15.54"
522 522
523This append file 523This append file
524contains statements used to support several BSPs that ship with the 524contains statements used to support several BSPs that ship with the
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 148eebf56a..7d537bf878 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -3943,7 +3943,7 @@ system and gives an overview of their function and contents.
3943 3943
3944 Values for this variable are set in the kernel's recipe file and the 3944 Values for this variable are set in the kernel's recipe file and the
3945 kernel's append file. For example, if you are using the 3945 kernel's append file. For example, if you are using the
3946 ``linux-yocto_4.12`` kernel, the kernel recipe file is the 3946 ``linux-yocto_5.15`` kernel, the kernel recipe file is the
3947 ``meta/recipes-kernel/linux/linux-yocto_4.12.bb`` file. :term:`KBRANCH` 3947 ``meta/recipes-kernel/linux/linux-yocto_4.12.bb`` file. :term:`KBRANCH`
3948 is set as follows in that kernel recipe file:: 3948 is set as follows in that kernel recipe file::
3949 3949
@@ -3956,13 +3956,13 @@ system and gives an overview of their function and contents.
3956 BSP layer for a given machine. For example, the append file for the 3956 BSP layer for a given machine. For example, the append file for the
3957 Beaglebone, EdgeRouter, and generic versions of both 32 and 64-bit IA 3957 Beaglebone, EdgeRouter, and generic versions of both 32 and 64-bit IA
3958 machines (``meta-yocto-bsp``) is named 3958 machines (``meta-yocto-bsp``) is named
3959 ``meta-yocto-bsp/recipes-kernel/linux/linux-yocto_4.12.bbappend``. 3959 ``meta-yocto-bsp/recipes-kernel/linux/linux-yocto_4.15.bbappend``.
3960 Here are the related statements from that append file:: 3960 Here are the related statements from that append file::
3961 3961
3962 KBRANCH:genericx86 = "standard/base" 3962 KBRANCH:genericx86 = "v5.15/standard/base"
3963 KBRANCH:genericx86-64 = "standard/base" 3963 KBRANCH:genericx86-64 = "v5.15/standard/base"
3964 KBRANCH:edgerouter = "standard/edgerouter" 3964 KBRANCH:edgerouter = "v5.15/standard/edgerouter"
3965 KBRANCH:beaglebone = "standard/beaglebone" 3965 KBRANCH:beaglebone-yocto = "v5.15/standard/beaglebone"
3966 3966
3967 The :term:`KBRANCH` statements 3967 The :term:`KBRANCH` statements
3968 identify the kernel branch to use when building for each supported 3968 identify the kernel branch to use when building for each supported