mirror of
https://git.yoctoproject.org/poky
synced 2026-05-30 12:29:55 +00:00
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>
This commit is contained in:
committed by
Richard Purdie
parent
4db4e4ca46
commit
020562cfbc
@@ -21,7 +21,7 @@ is the ``yocto-kernel-cache`` Git repository. You can find this repository
|
|||||||
grouped under the "Yocto Linux Kernel" heading in the
|
grouped under the "Yocto Linux Kernel" heading in the
|
||||||
:yocto_git:`Yocto Project Source Repositories <>`.
|
:yocto_git:`Yocto Project Source Repositories <>`.
|
||||||
|
|
||||||
Kernel development tools ("kern-tools") exist also in the Yocto Project
|
Kernel development tools ("kern-tools") are also available in the Yocto Project
|
||||||
Source Repositories under the "Yocto Linux Kernel" heading in the
|
Source Repositories under the "Yocto Linux Kernel" heading in the
|
||||||
``yocto-kernel-tools`` Git repository. The recipe that builds these
|
``yocto-kernel-tools`` Git repository. The recipe that builds these
|
||||||
tools is ``meta/recipes-kernel/kern-tools/kern-tools-native_git.bb`` in
|
tools 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
|
|||||||
|
|
||||||
The description file can
|
The description file can
|
||||||
include multiple patch statements where each statement handles a single
|
include multiple patch statements where each statement handles a single
|
||||||
patch. In the example ``build.scc`` file, five patch statements exist
|
patch. In the example ``build.scc`` file, there are five patch statements
|
||||||
for the five patches in the directory.
|
for the five patches in the directory.
|
||||||
|
|
||||||
You can create a typical ``.patch`` file using ``diff -Nurp`` or
|
You 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
|
|||||||
example supports the "beaglebone" machine for the "standard" kernel and
|
example supports the "beaglebone" machine for the "standard" kernel and
|
||||||
the "arm" architecture.
|
the "arm" architecture.
|
||||||
|
|
||||||
Be aware that a hard link between the ``KTYPE`` variable and a kernel
|
Be aware that there is no hard link between the ``KTYPE`` variable and a kernel
|
||||||
type description file does not exist. Thus, if you do not have the
|
type description file. Thus, if you do not have the
|
||||||
kernel type defined in your kernel Metadata as it is here, you only need
|
kernel type defined in your kernel Metadata as it is here, you only need
|
||||||
to ensure that the
|
to ensure that the
|
||||||
:term:`LINUX_KERNEL_TYPE`
|
:term:`LINUX_KERNEL_TYPE`
|
||||||
@@ -776,8 +776,8 @@ patches in every kernel you build (i.e. have the patches as part of the
|
|||||||
lone "master" branch). It is situations like these that give rise to
|
lone "master" branch). It is situations like these that give rise to
|
||||||
multiple branches used within a Linux kernel sources Git repository.
|
multiple branches used within a Linux kernel sources Git repository.
|
||||||
|
|
||||||
Repository organization strategies exist that maximize source reuse,
|
Here are repository organization strategies maximizing source reuse,
|
||||||
remove redundancy, and logically order your changes. This section
|
removing redundancy, and logically ordering your changes. This section
|
||||||
presents strategies for the following cases:
|
presents strategies for the following cases:
|
||||||
|
|
||||||
- Encapsulating patches in a feature description and only including the
|
- Encapsulating patches in a feature description and only including the
|
||||||
|
|||||||
@@ -578,7 +578,7 @@ recipe is processed.
|
|||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
|
||||||
Other methods exist to accomplish grouping and defining configuration
|
There are other ways of grouping and defining configuration
|
||||||
options. For example, if you are working with a local clone of the
|
options. For example, if you are working with a local clone of the
|
||||||
kernel repository, you could checkout the kernel's ``meta`` branch,
|
kernel repository, you could checkout the kernel's ``meta`` branch,
|
||||||
make your changes, and then push the changes to the local bare clone
|
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
|
|||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
|
||||||
During the checkout operation, a bug exists that could cause
|
During the checkout operation, there is a bug that could cause
|
||||||
errors such as the following to appear:
|
errors such as the following:
|
||||||
|
|
||||||
.. code-block:: none
|
.. code-block:: none
|
||||||
|
|
||||||
@@ -1306,7 +1306,7 @@ steps:
|
|||||||
$ bitbake linux-yocto -c kernel_configme -f
|
$ bitbake linux-yocto -c kernel_configme -f
|
||||||
|
|
||||||
This step ensures that you create a
|
This step ensures that you create a
|
||||||
``.config`` file from a known state. Because situations exist where
|
``.config`` file from a known state. Because there are situations where
|
||||||
your build state might become unknown, it is best to run this task
|
your build state might become unknown, it is best to run this task
|
||||||
prior to starting ``menuconfig``.
|
prior to starting ``menuconfig``.
|
||||||
|
|
||||||
@@ -1536,7 +1536,7 @@ Working with a "Dirty" Kernel Version String
|
|||||||
============================================
|
============================================
|
||||||
|
|
||||||
If you build a kernel image and the version string has a "+" or a
|
If you build a kernel image and the version string has a "+" or a
|
||||||
"-dirty" at the end, uncommitted modifications exist in the kernel's
|
"-dirty" at the end, it means there are uncommitted modifications in the kernel's
|
||||||
source directory. Follow these steps to clean up the version string:
|
source directory. Follow these steps to clean up the version string:
|
||||||
|
|
||||||
1. *Discover the Uncommitted Changes:* Go to the kernel's locally cloned
|
1. *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:
|
|||||||
|
|
||||||
Running the ``make defconfig`` command results in the default
|
Running the ``make defconfig`` command results in the default
|
||||||
configuration for your architecture as defined by your kernel.
|
configuration for your architecture as defined by your kernel.
|
||||||
However, no guarantee exists that this configuration is valid for
|
However, there is no guarantee that this configuration is valid for
|
||||||
your use case, or that your board will even boot. This is
|
your use case, or that your board will even boot. This is
|
||||||
particularly true for non-x86 architectures.
|
particularly true for non-x86 architectures.
|
||||||
|
|
||||||
|
|||||||
@@ -213,7 +213,7 @@ BSP-specific commits. In other words, the divisions of the kernel are
|
|||||||
transparent and are not relevant to the developer on a day-to-day basis.
|
transparent and are not relevant to the developer on a day-to-day basis.
|
||||||
From the developer's perspective, this path is the "master" branch in
|
From the developer's perspective, this path is the "master" branch in
|
||||||
Git terms. The developer does not need to be aware of the existence of
|
Git terms. The developer does not need to be aware of the existence of
|
||||||
any other branches at all. Of course, value exists in the having these
|
any other branches at all. Of course, it can make sense to have these
|
||||||
branches in the tree, should a person decide to explore them. For
|
branches in the tree, should a person decide to explore them. For
|
||||||
example, a comparison between two BSPs at either the commit level or at
|
example, a comparison between two BSPs at either the commit level or at
|
||||||
the line-by-line code ``diff`` level is now a trivial operation.
|
the line-by-line code ``diff`` level is now a trivial operation.
|
||||||
|
|||||||
@@ -66,9 +66,9 @@ from the continual kernel integration and testing performed during
|
|||||||
development of the Yocto Project.
|
development of the Yocto Project.
|
||||||
|
|
||||||
If, instead, you have a very specific Linux kernel source tree and are
|
If, instead, you have a very specific Linux kernel source tree and are
|
||||||
unable to align with one of the official Yocto Linux kernel recipes, an
|
unable to align with one of the official Yocto Linux kernel recipes,
|
||||||
alternative exists by which you can use the Yocto Project Linux kernel
|
you have a way to use the Yocto Project Linux kernel tools with your
|
||||||
tools with your own kernel sources.
|
own kernel sources.
|
||||||
|
|
||||||
The remainder of this manual provides instructions for completing
|
The remainder of this manual provides instructions for completing
|
||||||
specific Linux kernel development tasks. These instructions assume you
|
specific Linux kernel development tasks. These instructions assume you
|
||||||
|
|||||||
@@ -175,7 +175,7 @@ Build Strategy
|
|||||||
Once you have cloned a Yocto Linux kernel repository and the cache
|
Once you have cloned a Yocto Linux kernel repository and the cache
|
||||||
repository (``yocto-kernel-cache``) onto your development system, you
|
repository (``yocto-kernel-cache``) onto your development system, you
|
||||||
can consider the compilation phase of kernel development, which is
|
can consider the compilation phase of kernel development, which is
|
||||||
building a kernel image. Some prerequisites exist that are validated by
|
building a kernel image. Some prerequisites are validated by
|
||||||
the build process before compilation starts:
|
the build process before compilation starts:
|
||||||
|
|
||||||
- The :term:`SRC_URI` points to the
|
- The :term:`SRC_URI` points to the
|
||||||
@@ -194,7 +194,7 @@ the build process before compilation starts:
|
|||||||
In the previous example, the "yocto-4.12" branch is checked out in
|
In the previous example, the "yocto-4.12" branch is checked out in
|
||||||
the ``yocto-kernel-cache`` repository.
|
the ``yocto-kernel-cache`` repository.
|
||||||
|
|
||||||
The OpenEmbedded build system makes sure these conditions exist before
|
The OpenEmbedded build system makes sure these conditions are satisfied before
|
||||||
attempting compilation. Other means, however, do exist, such as
|
attempting compilation. Other means, however, do exist, such as
|
||||||
bootstrapping a BSP.
|
bootstrapping a BSP.
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user