mirror of
git://git.yoctoproject.org/poky.git
synced 2025-07-19 21:09:03 +02:00
c473fa2292
Many of the internal links were not converted probably from DocBook
using pandoc. After looking at the various patterns, the follow series
of 'naive' Python regexp were used to perform some additional
automatic conversion.
Also, since we rely on built-in glossary, all links to terms need to
use the sphinx :term: syntax.
This commit is generated using the following Python series of regexp:
line = re.sub("`+(\w+)`* <(\&YOCTO_DOCS_REF_URL;)?#var-\\1>`__",
":term:`\\1`",
line)
line = re.sub("`+do_([a-z_]+)`* <(\&YOCTO_DOCS_REF_URL;)?#ref-tasks-\\1>`__",
":ref:`ref-tasks-\\1`",
line)
line = re.sub("`+([a-z_\-\*\.]+).bbclass`* <(\&YOCTO_DOCS_REF_URL;)?#ref-classes-\\1>`__",
":ref:`\\1.bbclass <ref-classes-\\1>`",
line)
line = re.sub("`+([a-z_\-\*\.]+)`* <(\&YOCTO_DOCS_REF_URL;)?#ref-classes-\\1>`__",
":ref:`\\1 <ref-classes-\\1>`",
line)
line = re.sub("`Source Directory <(\&YOCTO_DOCS_REF_URL;)?#source-directory>`__",
":term:`Source Directory`",
line)
line = re.sub("`Build Directory <(\&YOCTO_DOCS_REF_URL;)?#build-directory>`__",
":term:`Build Directory`",
line)
line = re.sub("`Metadata <(\&YOCTO_DOCS_REF_URL;)?#metadata>`__",
":term:`Metadata`",
line)
line = re.sub("`BitBake <(\&YOCTO_DOCS_REF_URL;)?#bitbake-term>`__",
":term:`BitBake`",
line)
line = re.sub("`Images <(\&YOCTO_DOCS_REF_URL;)?#ref-images>`__",
":ref:`ref-manual/ref-images:Images`",
line)
line = re.sub("`Classes <(\&YOCTO_DOCS_REF_URL;)?#ref-classes>`__",
":ref:`ref-manual/ref-classes:Classes`",
line)
line = re.sub("`workspace <(\&YOCTO_DOCS_REF_URL;)?#devtool-the-workspace-layer-structure>`__",
":ref:`devtool-the-workspace-layer-structure`",
line)
line = re.sub("`Open-?Embedded b?B?uild s?S?ystem <(\&YOCTO_DOCS_REF_URL;)?#build-system-term>`__",
":term:`OpenEmbedded Build System`",
line)
line = re.sub("`(OpenEmbedded-Core )?(\(?OE-Core\)? )?<(\&YOCTO_DOCS_REF_URL;)?#oe-core>`__",
":term:`OpenEmbedded-Core (OE-Core)`",
line)
It won't catch multiline strings, but it catches a very large number
of occurences!
(From yocto-docs rev: 3f537d17de5b1fb76ba3bee196481984a4826378)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
46 lines
2.2 KiB
ReStructuredText
46 lines
2.2 KiB
ReStructuredText
.. SPDX-License-Identifier: CC-BY-2.0-UK
|
|
|
|
**********************
|
|
Kernel Development FAQ
|
|
**********************
|
|
|
|
.. _kernel-dev-faq-section:
|
|
|
|
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
|
|
``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
|
|
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
|
|
specific kernel module is included in an image, include it in the
|
|
appropriate machine
|
|
:term:`RRECOMMENDS` variable.
|
|
These other variables are useful for installing specific modules:
|
|
:term:`MACHINE_ESSENTIAL_EXTRA_RDEPENDS`
|
|
:term:`MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS`
|
|
:term:`MACHINE_EXTRA_RDEPENDS`
|
|
: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
|
|
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
|
|
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"
|