summaryrefslogtreecommitdiffstats
path: root/documentation/kernel-dev
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2021-05-12 11:30:15 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-05-22 12:16:40 +0100
commit020562cfbc3129c3cad7ebc8a5a8447681e5efed (patch)
tree3b6ec01a5dcbce135f24b14639d83853e9711048 /documentation/kernel-dev
parent4db4e4ca46e8b23d5042d925ce5ad3073de4c3ed (diff)
downloadpoky-020562cfbc3129c3cad7ebc8a5a8447681e5efed.tar.gz
kernel-dev manual: simplify style
(From yocto-docs rev: 5bbbed35175ffcabb24bcac305d17563b8d9b9e3) 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.rst12
-rw-r--r--documentation/kernel-dev/common.rst12
-rw-r--r--documentation/kernel-dev/concepts-appx.rst2
-rw-r--r--documentation/kernel-dev/intro.rst6
-rw-r--r--documentation/kernel-dev/maint-appx.rst4
5 files changed, 18 insertions, 18 deletions
diff --git a/documentation/kernel-dev/advanced.rst b/documentation/kernel-dev/advanced.rst
index b0d03851b3..0e745c375d 100644
--- a/documentation/kernel-dev/advanced.rst
+++ b/documentation/kernel-dev/advanced.rst
@@ -21,7 +21,7 @@ is the ``yocto-kernel-cache`` Git repository. You can find this repository
21grouped under the "Yocto Linux Kernel" heading in the 21grouped under the "Yocto Linux Kernel" heading in the
22:yocto_git:`Yocto Project Source Repositories <>`. 22:yocto_git:`Yocto Project Source Repositories <>`.
23 23
24Kernel development tools ("kern-tools") exist also in the Yocto Project 24Kernel development tools ("kern-tools") are also available in the Yocto Project
25Source Repositories under the "Yocto Linux Kernel" heading in the 25Source Repositories under the "Yocto Linux Kernel" heading in the
26``yocto-kernel-tools`` Git repository. The recipe that builds these 26``yocto-kernel-tools`` Git repository. The recipe that builds these
27tools is ``meta/recipes-kernel/kern-tools/kern-tools-native_git.bb`` in 27tools is ``meta/recipes-kernel/kern-tools/kern-tools-native_git.bb`` in
@@ -313,7 +313,7 @@ The following listings show the ``build.scc`` file and part of the
313 313
314The description file can 314The description file can
315include multiple patch statements where each statement handles a single 315include multiple patch statements where each statement handles a single
316patch. In the example ``build.scc`` file, five patch statements exist 316patch. In the example ``build.scc`` file, there are five patch statements
317for the five patches in the directory. 317for the five patches in the directory.
318 318
319You can create a typical ``.patch`` file using ``diff -Nurp`` or 319You can create a typical ``.patch`` file using ``diff -Nurp`` or
@@ -509,8 +509,8 @@ description as meeting the criteria set by the recipe being built. This
509example supports the "beaglebone" machine for the "standard" kernel and 509example supports the "beaglebone" machine for the "standard" kernel and
510the "arm" architecture. 510the "arm" architecture.
511 511
512Be aware that a hard link between the ``KTYPE`` variable and a kernel 512Be aware that there is no hard link between the ``KTYPE`` variable and a kernel
513type description file does not exist. Thus, if you do not have the 513type description file. Thus, if you do not have the
514kernel type defined in your kernel Metadata as it is here, you only need 514kernel type defined in your kernel Metadata as it is here, you only need
515to ensure that the 515to ensure that the
516:term:`LINUX_KERNEL_TYPE` 516:term:`LINUX_KERNEL_TYPE`
@@ -776,8 +776,8 @@ patches in every kernel you build (i.e. have the patches as part of the
776lone "master" branch). It is situations like these that give rise to 776lone "master" branch). It is situations like these that give rise to
777multiple branches used within a Linux kernel sources Git repository. 777multiple branches used within a Linux kernel sources Git repository.
778 778
779Repository organization strategies exist that maximize source reuse, 779Here are repository organization strategies maximizing source reuse,
780remove redundancy, and logically order your changes. This section 780removing redundancy, and logically ordering your changes. This section
781presents strategies for the following cases: 781presents strategies for the following cases:
782 782
783- Encapsulating patches in a feature description and only including the 783- Encapsulating patches in a feature description and only including the
diff --git a/documentation/kernel-dev/common.rst b/documentation/kernel-dev/common.rst
index 0fede0c012..f64cbab56c 100644
--- a/documentation/kernel-dev/common.rst
+++ b/documentation/kernel-dev/common.rst
@@ -578,7 +578,7 @@ recipe is processed.
578 578
579.. note:: 579.. note::
580 580
581 Other methods exist to accomplish grouping and defining configuration 581 There are other ways of grouping and defining configuration
582 options. For example, if you are working with a local clone of the 582 options. For example, if you are working with a local clone of the
583 kernel repository, you could checkout the kernel's ``meta`` branch, 583 kernel repository, you could checkout the kernel's ``meta`` branch,
584 make your changes, and then push the changes to the local bare clone 584 make your changes, and then push the changes to the local bare clone
@@ -781,8 +781,8 @@ the ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" Se
781 781
782 .. note:: 782 .. note::
783 783
784 During the checkout operation, a bug exists that could cause 784 During the checkout operation, there is a bug that could cause
785 errors such as the following to appear: 785 errors such as the following:
786 786
787 .. code-block:: none 787 .. code-block:: none
788 788
@@ -1306,7 +1306,7 @@ steps:
1306 $ bitbake linux-yocto -c kernel_configme -f 1306 $ bitbake linux-yocto -c kernel_configme -f
1307 1307
1308 This step ensures that you create a 1308 This step ensures that you create a
1309 ``.config`` file from a known state. Because situations exist where 1309 ``.config`` file from a known state. Because there are situations where
1310 your build state might become unknown, it is best to run this task 1310 your build state might become unknown, it is best to run this task
1311 prior to starting ``menuconfig``. 1311 prior to starting ``menuconfig``.
1312 1312
@@ -1536,7 +1536,7 @@ Working with a "Dirty" Kernel Version String
1536============================================ 1536============================================
1537 1537
1538If you build a kernel image and the version string has a "+" or a 1538If you build a kernel image and the version string has a "+" or a
1539"-dirty" at the end, uncommitted modifications exist in the kernel's 1539"-dirty" at the end, it means there are uncommitted modifications in the kernel's
1540source directory. Follow these steps to clean up the version string: 1540source directory. Follow these steps to clean up the version string:
1541 1541
15421. *Discover the Uncommitted Changes:* Go to the kernel's locally cloned 15421. *Discover the Uncommitted Changes:* Go to the kernel's locally cloned
@@ -1615,7 +1615,7 @@ Here are some basic steps you can use to work with your own sources:
1615 1615
1616 Running the ``make defconfig`` command results in the default 1616 Running the ``make defconfig`` command results in the default
1617 configuration for your architecture as defined by your kernel. 1617 configuration for your architecture as defined by your kernel.
1618 However, no guarantee exists that this configuration is valid for 1618 However, there is no guarantee that this configuration is valid for
1619 your use case, or that your board will even boot. This is 1619 your use case, or that your board will even boot. This is
1620 particularly true for non-x86 architectures. 1620 particularly true for non-x86 architectures.
1621 1621
diff --git a/documentation/kernel-dev/concepts-appx.rst b/documentation/kernel-dev/concepts-appx.rst
index 2101f374cb..cf2e75d853 100644
--- a/documentation/kernel-dev/concepts-appx.rst
+++ b/documentation/kernel-dev/concepts-appx.rst
@@ -213,7 +213,7 @@ BSP-specific commits. In other words, the divisions of the kernel are
213transparent and are not relevant to the developer on a day-to-day basis. 213transparent and are not relevant to the developer on a day-to-day basis.
214From the developer's perspective, this path is the "master" branch in 214From the developer's perspective, this path is the "master" branch in
215Git terms. The developer does not need to be aware of the existence of 215Git terms. The developer does not need to be aware of the existence of
216any other branches at all. Of course, value exists in the having these 216any other branches at all. Of course, it can make sense to have these
217branches in the tree, should a person decide to explore them. For 217branches in the tree, should a person decide to explore them. For
218example, a comparison between two BSPs at either the commit level or at 218example, a comparison between two BSPs at either the commit level or at
219the line-by-line code ``diff`` level is now a trivial operation. 219the line-by-line code ``diff`` level is now a trivial operation.
diff --git a/documentation/kernel-dev/intro.rst b/documentation/kernel-dev/intro.rst
index 5592f74c82..e406f6e47f 100644
--- a/documentation/kernel-dev/intro.rst
+++ b/documentation/kernel-dev/intro.rst
@@ -66,9 +66,9 @@ from the continual kernel integration and testing performed during
66development of the Yocto Project. 66development of the Yocto Project.
67 67
68If, instead, you have a very specific Linux kernel source tree and are 68If, instead, you have a very specific Linux kernel source tree and are
69unable to align with one of the official Yocto Linux kernel recipes, an 69unable to align with one of the official Yocto Linux kernel recipes,
70alternative exists by which you can use the Yocto Project Linux kernel 70you have a way to use the Yocto Project Linux kernel tools with your
71tools with your own kernel sources. 71own kernel sources.
72 72
73The remainder of this manual provides instructions for completing 73The remainder of this manual provides instructions for completing
74specific Linux kernel development tasks. These instructions assume you 74specific Linux kernel development tasks. These instructions assume you
diff --git a/documentation/kernel-dev/maint-appx.rst b/documentation/kernel-dev/maint-appx.rst
index f84ab6e239..3354de5f0c 100644
--- a/documentation/kernel-dev/maint-appx.rst
+++ b/documentation/kernel-dev/maint-appx.rst
@@ -175,7 +175,7 @@ Build Strategy
175Once you have cloned a Yocto Linux kernel repository and the cache 175Once you have cloned a Yocto Linux kernel repository and the cache
176repository (``yocto-kernel-cache``) onto your development system, you 176repository (``yocto-kernel-cache``) onto your development system, you
177can consider the compilation phase of kernel development, which is 177can consider the compilation phase of kernel development, which is
178building a kernel image. Some prerequisites exist that are validated by 178building a kernel image. Some prerequisites are validated by
179the build process before compilation starts: 179the build process before compilation starts:
180 180
181- The :term:`SRC_URI` points to the 181- The :term:`SRC_URI` points to the
@@ -194,7 +194,7 @@ the build process before compilation starts:
194 In the previous example, the "yocto-4.12" branch is checked out in 194 In the previous example, the "yocto-4.12" branch is checked out in
195 the ``yocto-kernel-cache`` repository. 195 the ``yocto-kernel-cache`` repository.
196 196
197The OpenEmbedded build system makes sure these conditions exist before 197The OpenEmbedded build system makes sure these conditions are satisfied before
198attempting compilation. Other means, however, do exist, such as 198attempting compilation. Other means, however, do exist, such as
199bootstrapping a BSP. 199bootstrapping a BSP.
200 200