From cb37a15cf5a150489ceaf55dc6cb014f0e787f6e Mon Sep 17 00:00:00 2001 From: Richard Purdie Date: Mon, 14 Sep 2020 16:19:23 +0100 Subject: sphinx: kernel-dev: Various URL, code block and other fixes to imported data (From yocto-docs rev: 4888b49ccc5d133b4096e5a9b808f14d1afc7deb) Signed-off-by: Richard Purdie --- documentation/kernel-dev/kernel-dev-faq.rst | 70 ++++++++++++++++++++++------- 1 file changed, 53 insertions(+), 17 deletions(-) (limited to 'documentation/kernel-dev/kernel-dev-faq.rst') diff --git a/documentation/kernel-dev/kernel-dev-faq.rst b/documentation/kernel-dev/kernel-dev-faq.rst index fd9f8ce33d..b5e6a84eba 100644 --- a/documentation/kernel-dev/kernel-dev-faq.rst +++ b/documentation/kernel-dev/kernel-dev-faq.rst @@ -9,23 +9,46 @@ Kernel Development FAQ Common Questions and Solutions ============================== -The following lists some solutions for common questions. How do I use my -own Linux kernel ``.config`` file? Refer to the "`Changing the -Configuration <#changing-the-configuration>`__" section for information. -How do I create configuration fragments? Refer to the "`Creating -Configuration Fragments <#creating-config-fragments>`__" section for -information. How do I use my own Linux kernel sources? Refer to the -"`Working With Your Own Sources <#working-with-your-own-sources>`__" -section for information. How do I install/not-install the kernel image -on the rootfs? The kernel image (e.g. ``vmlinuz``) is provided by the +The following lists some solutions for common questions. + +How do I use my own Linux kernel ``.config`` file? +-------------------------------------------------- + +Refer to the +":ref:`kernel-dev/kernel-dev-common:changing the configuration`" +section for information. + +How do I create configuration fragments? +---------------------------------------- + +A: Refer to the +":ref:`kernel-dev/kernel-dev-common:creating configuration fragments`" +section for information. + +How do I use my own Linux kernel sources? +----------------------------------------- + +Refer to the +":ref:`kernel-dev/kernel-dev-common:working with your own sources`" +section for information. + +How do I install/not-install the kernel image on the rootfs? +------------------------------------------------------------ + +The kernel image (e.g. ``vmlinuz``) is provided by the ``kernel-image`` package. Image recipes depend on ``kernel-base``. To specify whether or not the kernel image is installed in the generated root filesystem, override ``RDEPENDS_kernel-base`` to include or not -include "kernel-image". See the "`Using .bbappend Files in Your -Layer <&YOCTO_DOCS_DEV_URL;#using-bbappend-files>`__" section in the +include "kernel-image". See the +":ref:`dev-manual/dev-manual-common-tasks:using .bbappend files in your layer`" +section in the Yocto Project Development Tasks Manual for information on how to use an -append file to override metadata. How do I install a specific kernel -module? Linux kernel modules are packaged individually. To ensure a +append file to override metadata. + +How do I install a specific kernel module? +------------------------------------------ + +Linux kernel modules are packaged individually. To ensure a specific kernel module is included in an image, include it in the appropriate machine :term:`RRECOMMENDS` variable. @@ -36,10 +59,23 @@ These other variables are useful for installing specific modules: :term:`MACHINE_EXTRA_RRECOMMENDS` For example, set the following in the ``qemux86.conf`` file to include the ``ab123`` kernel modules with images built for the ``qemux86`` -machine: MACHINE_EXTRA_RRECOMMENDS += "kernel-module-ab123" For more +machine: +:: + + MACHINE_EXTRA_RRECOMMENDS += "kernel-module-ab123" + +For more information, see the "`Incorporating Out-of-Tree -Modules <#incorporating-out-of-tree-modules>`__" section. How do I -change the Linux kernel command line? The Linux kernel command line is +Modules <#incorporating-out-of-tree-modules>`__" section. + +How do I change the Linux kernel command line? +---------------------------------------------- + +The Linux kernel command line is typically specified in the machine config using the ``APPEND`` variable. For example, you can add some helpful debug information doing the -following: APPEND += "printk.time=y initcall_debug debug" +following: +:: + + APPEND += "printk.time=y initcall_debug debug" + -- cgit v1.2.3-54-g00ecf