summaryrefslogtreecommitdiffstats
path: root/documentation/kernel-dev
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2021-08-04 20:15:37 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-08-14 12:04:23 +0100
commit80859f21b5ceea8efdc09d0f0de24cc70a749d48 (patch)
treeeced0bb55c218f1a5496ba82de7d6aebf838be7e /documentation/kernel-dev
parentded502d2a751a9c0b0a0ed4e2076fa65ca9e803a (diff)
downloadpoky-80859f21b5ceea8efdc09d0f0de24cc70a749d48.tar.gz
kernel-dev manual: overrides syntax updates
Updated with openembedded-core/scripts/contrib/convert-overrides.py (From yocto-docs rev: d4598b592d1b0c9ce9448a8858eb4f47d83487b2) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/kernel-dev')
-rw-r--r--documentation/kernel-dev/advanced.rst6
-rw-r--r--documentation/kernel-dev/common.rst60
2 files changed, 33 insertions, 33 deletions
diff --git a/documentation/kernel-dev/advanced.rst b/documentation/kernel-dev/advanced.rst
index 871ec8ae7b..9c3a478cb9 100644
--- a/documentation/kernel-dev/advanced.rst
+++ b/documentation/kernel-dev/advanced.rst
@@ -69,7 +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:edgerouter = "standard/edgerouter"
73 73
74 74
75The linux-yocto style recipes can optionally define the following 75The linux-yocto style recipes can optionally define the following
@@ -113,7 +113,7 @@ To include a
113feature called "cfg/sound.scc" just for the ``qemux86`` machine, 113feature called "cfg/sound.scc" just for the ``qemux86`` machine,
114specify:: 114specify::
115 115
116 KERNEL_FEATURES_append_qemux86 = " cfg/sound.scc" 116 KERNEL_FEATURES:append:qemux86 = " cfg/sound.scc"
117 117
118The value of 118The value of
119the entries in :term:`KERNEL_FEATURES` are dependent on their location 119the entries in :term:`KERNEL_FEATURES` are dependent on their location
@@ -724,7 +724,7 @@ If the BSP description is in recipe space, you cannot simply list the
724``*.scc`` in the :term:`SRC_URI` statement. You need to use the following 724``*.scc`` in the :term:`SRC_URI` statement. You need to use the following
725form from your kernel append file:: 725form from your kernel append file::
726 726
727 SRC_URI_append_myplatform = " \ 727 SRC_URI:append_myplatform = " \
728 file://myplatform;type=kmeta;destsuffix=myplatform \ 728 file://myplatform;type=kmeta;destsuffix=myplatform \
729 " 729 "
730 730
diff --git a/documentation/kernel-dev/common.rst b/documentation/kernel-dev/common.rst
index a97140b0b9..331e982aca 100644
--- a/documentation/kernel-dev/common.rst
+++ b/documentation/kernel-dev/common.rst
@@ -416,11 +416,11 @@ home directory:
416 kernel. Thus, the name of the append file is 416 kernel. Thus, the name of the append file is
417 ``linux-yocto_4.12.bbappend``:: 417 ``linux-yocto_4.12.bbappend``::
418 418
419 FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:" 419 FILESEXTRAPATHS:prepend := "${THISDIR}/${PN}:"
420 420
421 SRC_URI_append = " file://patch-file-one.patch" 421 SRC_URI:append = " file://patch-file-one.patch"
422 SRC_URI_append = " file://patch-file-two.patch" 422 SRC_URI:append = " file://patch-file-two.patch"
423 SRC_URI_append = " file://patch-file-three.patch" 423 SRC_URI:append = " file://patch-file-three.patch"
424 424
425 The :term:`FILESEXTRAPATHS` and :term:`SRC_URI` statements 425 The :term:`FILESEXTRAPATHS` and :term:`SRC_URI` statements
426 enable the OpenEmbedded build system to find patch files. For more 426 enable the OpenEmbedded build system to find patch files. For more
@@ -469,7 +469,7 @@ prepending the directory that contains your files to the
469:term:`FILESEXTRAPATHS` 469:term:`FILESEXTRAPATHS`
470variable as follows:: 470variable as follows::
471 471
472 FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:" 472 FILESEXTRAPATHS:prepend := "${THISDIR}/${PN}:"
473 473
474The path ``${``\ :term:`THISDIR`\ ``}/${``\ :term:`PN`\ ``}`` 474The path ``${``\ :term:`THISDIR`\ ``}/${``\ :term:`PN`\ ``}``
475expands to "linux-yocto" in the current directory for this example. If 475expands to "linux-yocto" in the current directory for this example. If
@@ -496,28 +496,28 @@ strings 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 = "standard/base"
500 KBRANCH_genericx86-64 = "standard/base" 500 KBRANCH:genericx86-64 = "standard/base"
501 501
502 KMACHINE_genericx86 ?= "common-pc" 502 KMACHINE:genericx86 ?= "common-pc"
503 KMACHINE_genericx86-64 ?= "common-pc-64" 503 KMACHINE:genericx86-64 ?= "common-pc-64"
504 KBRANCH_edgerouter = "standard/edgerouter" 504 KBRANCH:edgerouter = "standard/edgerouter"
505 KBRANCH_beaglebone = "standard/beaglebone" 505 KBRANCH_beaglebone = "standard/beaglebone"
506 506
507 SRCREV_machine_genericx86 ?= "d09f2ce584d60ecb7890550c22a80c48b83c2e19" 507 SRCREV_machine:genericx86 ?= "d09f2ce584d60ecb7890550c22a80c48b83c2e19"
508 SRCREV_machine_genericx86-64 ?= "d09f2ce584d60ecb7890550c22a80c48b83c2e19" 508 SRCREV_machine:genericx86-64 ?= "d09f2ce584d60ecb7890550c22a80c48b83c2e19"
509 SRCREV_machine_edgerouter ?= "b5c8cfda2dfe296410d51e131289fb09c69e1e7d" 509 SRCREV_machine:edgerouter ?= "b5c8cfda2dfe296410d51e131289fb09c69e1e7d"
510 SRCREV_machine_beaglebone ?= "b5c8cfda2dfe296410d51e131289fb09c69e1e7d" 510 SRCREV_machine_beaglebone ?= "b5c8cfda2dfe296410d51e131289fb09c69e1e7d"
511 511
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 = "beaglebone"
517 517
518 LINUX_VERSION_genericx86 = "4.12.7" 518 LINUX_VERSION:genericx86 = "4.12.7"
519 LINUX_VERSION_genericx86-64 = "4.12.7" 519 LINUX_VERSION:genericx86-64 = "4.12.7"
520 LINUX_VERSION_edgerouter = "4.12.10" 520 LINUX_VERSION:edgerouter = "4.12.10"
521 LINUX_VERSION_beaglebone = "4.12.10" 521 LINUX_VERSION_beaglebone = "4.12.10"
522 522
523This append file 523This append file
@@ -640,7 +640,7 @@ appropriate ``${PN}`` directory in your layer's ``recipes-kernel/linux``
640directory, and rename the copied file to "defconfig". Then, add the 640directory, and rename the copied file to "defconfig". Then, add the
641following lines to the linux-yocto ``.bbappend`` file in your layer:: 641following lines to the linux-yocto ``.bbappend`` file in your layer::
642 642
643 FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:" 643 FILESEXTRAPATHS:prepend := "${THISDIR}/${PN}:"
644 SRC_URI += "file://defconfig" 644 SRC_URI += "file://defconfig"
645 645
646The :term:`SRC_URI` tells the build system how to search 646The :term:`SRC_URI` tells the build system how to search
@@ -687,7 +687,7 @@ Next, include this
687configuration fragment and extend the :term:`FILESPATH` variable in your 687configuration fragment and extend the :term:`FILESPATH` variable in your
688``.bbappend`` file:: 688``.bbappend`` file::
689 689
690 FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:" 690 FILESEXTRAPATHS:prepend := "${THISDIR}/${PN}:"
691 SRC_URI += "file://8250.cfg" 691 SRC_URI += "file://8250.cfg"
692 692
693The next time you run BitBake to build the 693The next time you run BitBake to build the
@@ -988,10 +988,10 @@ Section.
988 988
989 Add the following to the ``local.conf``:: 989 Add the following to the ``local.conf``::
990 990
991 SRC_URI_pn-linux-yocto = "git:///path-to/linux-yocto-4.12;protocol=file;name=machine;branch=standard/base; \ 991 SRC_URI:pn-linux-yocto = "git:///path-to/linux-yocto-4.12;protocol=file;name=machine;branch=standard/base; \
992 git:///path-to/yocto-kernel-cache;protocol=file;type=kmeta;name=meta;branch=yocto-4.12;destsuffix=${KMETA}" 992 git:///path-to/yocto-kernel-cache;protocol=file;type=kmeta;name=meta;branch=yocto-4.12;destsuffix=${KMETA}"
993 SRCREV_meta_qemux86 = "${AUTOREV}" 993 SRCREV_meta:qemux86 = "${AUTOREV}"
994 SRCREV_machine_qemux86 = "${AUTOREV}" 994 SRCREV_machine:qemux86 = "${AUTOREV}"
995 995
996 .. note:: 996 .. note::
997 997
@@ -1061,8 +1061,8 @@ Section.
1061 must be named ``linux-yocto_4.12.bbappend`` and have the following 1061 must be named ``linux-yocto_4.12.bbappend`` and have the following
1062 contents:: 1062 contents::
1063 1063
1064 FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:" 1064 FILESEXTRAPATHS:prepend := "${THISDIR}/${PN}:"
1065 SRC_URI_append = "file://0001-calibrate.c-Added-some-printk-statements.patch" 1065 SRC_URI:append = "file://0001-calibrate.c-Added-some-printk-statements.patch"
1066 1066
1067 The :term:`FILESEXTRAPATHS` and :term:`SRC_URI` statements 1067 The :term:`FILESEXTRAPATHS` and :term:`SRC_URI` statements
1068 enable the OpenEmbedded build system to find the patch file. 1068 enable the OpenEmbedded build system to find the patch file.
@@ -1237,7 +1237,7 @@ file to "defconfig" (e.g.
1237add the following lines to the linux-yocto ``.bbappend`` file in your 1237add the following lines to the linux-yocto ``.bbappend`` file in your
1238layer:: 1238layer::
1239 1239
1240 FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:" 1240 FILESEXTRAPATHS:prepend := "${THISDIR}/${PN}:"
1241 SRC_URI += "file://defconfig" 1241 SRC_URI += "file://defconfig"
1242 1242
1243The :term:`SRC_URI` tells the build system how to search for the file, while the 1243The :term:`SRC_URI` tells the build system how to search for the file, while the
@@ -1345,7 +1345,7 @@ the kernel's append file within your layer and then add the following
1345statements to the kernel's append file, those configuration options will 1345statements to the kernel's append file, those configuration options will
1346be picked up and applied when the kernel is built:: 1346be picked up and applied when the kernel is built::
1347 1347
1348 FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:" 1348 FILESEXTRAPATHS:prepend := "${THISDIR}/${PN}:"
1349 SRC_URI += "file://myconfig.cfg" 1349 SRC_URI += "file://myconfig.cfg"
1350 1350
1351As mentioned earlier, you can group related configurations into multiple 1351As mentioned earlier, you can group related configurations into multiple
@@ -1939,7 +1939,7 @@ build.
19392. *Add the Feature File to SRC_URI:* Add the ``.scc`` file to the 19392. *Add the Feature File to SRC_URI:* Add the ``.scc`` file to the
1940 recipe's :term:`SRC_URI` statement:: 1940 recipe's :term:`SRC_URI` statement::
1941 1941
1942 SRC_URI_append = " file://test.scc" 1942 SRC_URI:append = " file://test.scc"
1943 1943
1944 The leading space before the path is important as the path is 1944 The leading space before the path is important as the path is
1945 appended to the existing path. 1945 appended to the existing path.
@@ -1948,7 +1948,7 @@ build.
1948 :term:`KERNEL_FEATURES` statement to specify the feature as a kernel 1948 :term:`KERNEL_FEATURES` statement to specify the feature as a kernel
1949 feature:: 1949 feature::
1950 1950
1951 KERNEL_FEATURES_append = " test.scc" 1951 KERNEL_FEATURES:append = " test.scc"
1952 1952
1953 The OpenEmbedded build 1953 The OpenEmbedded build
1954 system processes the kernel feature when it builds the kernel. 1954 system processes the kernel feature when it builds the kernel.