summaryrefslogtreecommitdiffstats
path: root/documentation/kernel-dev/kernel-dev-faq.rst
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-11-20 20:17:33 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-01-04 10:55:00 +0000
commitfa0cb4d34b1073f215fa3c680f2316208739d53d (patch)
treeba89c1f4289fd6456af4409a6a19caf6548dfb9c /documentation/kernel-dev/kernel-dev-faq.rst
parenta038e58f3cd82c56102444bdc5ac76c9f1550a0d (diff)
downloadpoky-fa0cb4d34b1073f215fa3c680f2316208739d53d.tar.gz
sphinx: import docs
The Yocto Project docs was migrated from Docbook to Sphinx in YP 3.2. This 3.1 is an LTS release, and since 3.1 docs are 'close to' the docs in 3.2, we agreed to backport sphinx docs onto 3.1. This first patch brings all changes done in 3.2 until: 7f64574f7 README: include detailed information about sphinx There are other changes after this commit, but they will be selectively backported in individual patches. This patch was generated with the following command: git cherry-pick -n \ $(git log --reverse --oneline \ ac352ad7f95db7eeacb53c2778caa31800bd7c26..7f64574f7 \ | cut -f1 -d' ') The following commits were applies in the dunfell docs, but not in master, so they were first reverted (and squashed into this change). A commit will reintroduce the content from these patches in the Sphinx files in a followup patch. 069c27574 Documenation: Prepared for the 3.1.1 release bd140f0f9 Documentation: Add 3.1.1 version updates missing from previous commit 17cc71a8f Documenation: Prepared for the 3.1.2 release 1a69e2c02 Documenation: Prepared for the 3.1.3 release 8910ac1c7 Documenation: Prepared for the 3.1.4 release (From yocto-docs rev: c25fe058b88b893b0d146f3ed27320b47cdec236) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/kernel-dev/kernel-dev-faq.rst')
-rw-r--r--documentation/kernel-dev/kernel-dev-faq.rst81
1 files changed, 81 insertions, 0 deletions
diff --git a/documentation/kernel-dev/kernel-dev-faq.rst b/documentation/kernel-dev/kernel-dev-faq.rst
new file mode 100644
index 0000000000..b5e6a84eba
--- /dev/null
+++ b/documentation/kernel-dev/kernel-dev-faq.rst
@@ -0,0 +1,81 @@
1.. SPDX-License-Identifier: CC-BY-2.0-UK
2
3**********************
4Kernel Development FAQ
5**********************
6
7.. _kernel-dev-faq-section:
8
9Common Questions and Solutions
10==============================
11
12The following lists some solutions for common questions.
13
14How do I use my own Linux kernel ``.config`` file?
15--------------------------------------------------
16
17Refer to the
18":ref:`kernel-dev/kernel-dev-common:changing the configuration`"
19section for information.
20
21How do I create configuration fragments?
22----------------------------------------
23
24A: Refer to the
25":ref:`kernel-dev/kernel-dev-common:creating configuration fragments`"
26section for information.
27
28How do I use my own Linux kernel sources?
29-----------------------------------------
30
31Refer to the
32":ref:`kernel-dev/kernel-dev-common:working with your own sources`"
33section for information.
34
35How do I install/not-install the kernel image on the rootfs?
36------------------------------------------------------------
37
38The kernel image (e.g. ``vmlinuz``) is provided by the
39``kernel-image`` package. Image recipes depend on ``kernel-base``. To
40specify whether or not the kernel image is installed in the generated
41root filesystem, override ``RDEPENDS_kernel-base`` to include or not
42include "kernel-image". See the
43":ref:`dev-manual/dev-manual-common-tasks:using .bbappend files in your layer`"
44section in the
45Yocto Project Development Tasks Manual for information on how to use an
46append file to override metadata.
47
48How do I install a specific kernel module?
49------------------------------------------
50
51Linux kernel modules are packaged individually. To ensure a
52specific kernel module is included in an image, include it in the
53appropriate machine
54:term:`RRECOMMENDS` variable.
55These other variables are useful for installing specific modules:
56:term:`MACHINE_ESSENTIAL_EXTRA_RDEPENDS`
57:term:`MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS`
58:term:`MACHINE_EXTRA_RDEPENDS`
59:term:`MACHINE_EXTRA_RRECOMMENDS`
60For example, set the following in the ``qemux86.conf`` file to include
61the ``ab123`` kernel modules with images built for the ``qemux86``
62machine:
63::
64
65 MACHINE_EXTRA_RRECOMMENDS += "kernel-module-ab123"
66
67For more
68information, see the "`Incorporating Out-of-Tree
69Modules <#incorporating-out-of-tree-modules>`__" section.
70
71How do I change the Linux kernel command line?
72----------------------------------------------
73
74The Linux kernel command line is
75typically specified in the machine config using the ``APPEND`` variable.
76For example, you can add some helpful debug information doing the
77following:
78::
79
80 APPEND += "printk.time=y initcall_debug debug"
81