summaryrefslogtreecommitdiffstats
path: root/documentation/kernel-dev/kernel-dev-maint-appx.rst
diff options
context:
space:
mode:
authorRichard Purdie <richard.purdie@linuxfoundation.org>2020-09-14 16:19:23 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-09-17 10:09:35 +0100
commitcb37a15cf5a150489ceaf55dc6cb014f0e787f6e (patch)
tree2df2f45981d11b46d34ca860a9582365f3efef10 /documentation/kernel-dev/kernel-dev-maint-appx.rst
parentde89b5a0b6ecb9a5b6a3e5a862cf4cee32dc8a94 (diff)
downloadpoky-cb37a15cf5a150489ceaf55dc6cb014f0e787f6e.tar.gz
sphinx: kernel-dev: Various URL, code block and other fixes to imported data
(From yocto-docs rev: 4888b49ccc5d133b4096e5a9b808f14d1afc7deb) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/kernel-dev/kernel-dev-maint-appx.rst')
-rw-r--r--documentation/kernel-dev/kernel-dev-maint-appx.rst35
1 files changed, 24 insertions, 11 deletions
diff --git a/documentation/kernel-dev/kernel-dev-maint-appx.rst b/documentation/kernel-dev/kernel-dev-maint-appx.rst
index 0b0cca14a7..5514dac876 100644
--- a/documentation/kernel-dev/kernel-dev-maint-appx.rst
+++ b/documentation/kernel-dev/kernel-dev-maint-appx.rst
@@ -28,12 +28,17 @@ in the Yocto Project Linux kernel in any clone of the Yocto Project
28Linux kernel source repository and ``yocto-kernel-cache`` Git trees. For 28Linux kernel source repository and ``yocto-kernel-cache`` Git trees. For
29example, the following commands clone the Yocto Project baseline Linux 29example, the following commands clone the Yocto Project baseline Linux
30kernel that branches off ``linux.org`` version 4.12 and the 30kernel that branches off ``linux.org`` version 4.12 and the
31``yocto-kernel-cache``, which contains stores of kernel Metadata: $ git 31``yocto-kernel-cache``, which contains stores of kernel Metadata:
32clone git://git.yoctoproject.org/linux-yocto-4.12 $ git clone 32::
33git://git.yoctoproject.org/linux-kernel-cache For more information on 33
34 $ git clone git://git.yoctoproject.org/linux-yocto-4.12
35 $ git clone git://git.yoctoproject.org/linux-kernel-cache
36
37For more information on
34how to set up a local Git repository of the Yocto Project Linux kernel 38how to set up a local Git repository of the Yocto Project Linux kernel
35files, see the "`Preparing the Build Host to Work on the 39files, see the
36Kernel <#preparing-the-build-host-to-work-on-the-kernel>`__" section. 40":ref:`kernel-dev/kernel-dev-common:preparing the build host to work on the kernel`"
41section.
37 42
38Once you have cloned the kernel Git repository and the cache of Metadata 43Once you have cloned the kernel Git repository and the cache of Metadata
39on your local machine, you can discover the branches that are available 44on your local machine, you can discover the branches that are available
@@ -41,10 +46,13 @@ in the repository using the following Git command: $ git branch -a
41Checking out a branch allows you to work with a particular Yocto Linux 46Checking out a branch allows you to work with a particular Yocto Linux
42kernel. For example, the following commands check out the 47kernel. For example, the following commands check out the
43"standard/beagleboard" branch of the Yocto Linux kernel repository and 48"standard/beagleboard" branch of the Yocto Linux kernel repository and
44the "yocto-4.12" branch of the ``yocto-kernel-cache`` repository: $ cd 49the "yocto-4.12" branch of the ``yocto-kernel-cache`` repository:
45~/linux-yocto-4.12 $ git checkout -b my-kernel-4.12 50::
46remotes/origin/standard/beagleboard $ cd ~/linux-kernel-cache $ git 51
47checkout -b my-4.12-metadata remotes/origin/yocto-4.12 52 $ cd ~/linux-yocto-4.12
53 $ git checkout -b my-kernel-4.12 remotes/origin/standard/beagleboard
54 $ cd ~/linux-kernel-cache
55 $ git checkout -b my-4.12-metadata remotes/origin/yocto-4.12
48 56
49.. note:: 57.. note::
50 58
@@ -102,7 +110,9 @@ patch, or BSP:
102 For a typical build, the target of the search is a feature 110 For a typical build, the target of the search is a feature
103 description in an ``.scc`` file whose name follows this format (e.g. 111 description in an ``.scc`` file whose name follows this format (e.g.
104 ``beaglebone-standard.scc`` and ``beaglebone-preempt-rt.scc``): 112 ``beaglebone-standard.scc`` and ``beaglebone-preempt-rt.scc``):
105 bsp_root_name-kernel_type.scc 113 ::
114
115 bsp_root_name-kernel_type.scc
106 116
1073. *Expand Feature:* Once located, the feature description is either 1173. *Expand Feature:* Once located, the feature description is either
108 expanded into a simple script of actions, or into an existing 118 expanded into a simple script of actions, or into an existing
@@ -212,7 +222,10 @@ build process generates a build tree that is separate from your kernel's
212local Git source repository tree. This build tree has a name that uses 222local Git source repository tree. This build tree has a name that uses
213the following form, where ``${MACHINE}`` is the metadata name of the 223the following form, where ``${MACHINE}`` is the metadata name of the
214machine (BSP) and "kernel_type" is one of the Yocto Project supported 224machine (BSP) and "kernel_type" is one of the Yocto Project supported
215kernel types (e.g. "standard"): linux-${MACHINE}-kernel_type-build 225kernel types (e.g. "standard"):
226::
227
228 linux-${MACHINE}-kernel_type-build
216 229
217The existing support in the ``kernel.org`` tree achieves this default 230The existing support in the ``kernel.org`` tree achieves this default
218functionality. 231functionality.