mirror of
https://git.yoctoproject.org/poky
synced 2026-01-29 21:08:42 +01:00
9bd69b1f1d
This commit is autogenerated pandoc to generate an inital set
of reST files based on DocBook XML files.
A .rst file is generated for each .xml files in all manuals with this
command:
cd <manual>
for i in *.xml; do \
pandoc -f docbook -t rst --shift-heading-level-by=-1 \
$i -o $(basename $i .xml).rst \
done
The conversion was done with: pandoc 2.9.2.1-91 (Arch Linux).
Also created an initial top level index file for each document, and
added all 'books' to the top leve index.rst file.
The YP manuals layout is organized as:
Book
Chapter
Section
Section
Section
Sphinx uses section headers to create the document structure.
ReStructuredText defines sections headers like that:
To break longer text up into sections, you use section headers. These
are a single line of text (one or more words) with adornment: an
underline alone, or an underline and an overline together, in dashes
"-----", equals "======", tildes "~~~~~~" or any of the
non-alphanumeric characters = - ` : ' " ~ ^ _ * + # < > that you feel
comfortable with. An underline-only adornment is distinct from an
overline-and-underline adornment using the same character. The
underline/overline must be at least as long as the title text. Be
consistent, since all sections marked with the same adornment style
are deemed to be at the same level:
Let's define the following convention when converting from Docbook:
Book => overline === (Title)
Chapter => overline *** (1.)
Section => ==== (1.1)
Section => ---- (1.1.1)
Section => ~~~~ (1.1.1.1)
Section => ^^^^ (1.1.1.1.1)
During the conversion with pandoc, we used --shift-heading-level=-1 to
convert most of DocBook headings automatically. However with this
setting, the Chapter header was removed, so I added it back
manually. Without this setting all headings were off by one, which was
more difficult to manually fix.
At least with this change, we now have the same TOC with Sphinx and
DocBook.
(From yocto-docs rev: 3c73d64a476d4423ee4c6808c685fa94d88d7df8)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
44 lines
2.5 KiB
ReStructuredText
44 lines
2.5 KiB
ReStructuredText
**********************
|
|
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
|
|
```RRECOMMENDS`` <&YOCTO_DOCS_REF_URL;#var-RRECOMMENDS>`__ variable.
|
|
These other variables are useful for installing specific modules:
|
|
```MACHINE_ESSENTIAL_EXTRA_RDEPENDS`` <&YOCTO_DOCS_REF_URL;#var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS>`__
|
|
```MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS`` <&YOCTO_DOCS_REF_URL;#var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS>`__
|
|
```MACHINE_EXTRA_RDEPENDS`` <&YOCTO_DOCS_REF_URL;#var-MACHINE_EXTRA_RDEPENDS>`__
|
|
```MACHINE_EXTRA_RRECOMMENDS`` <&YOCTO_DOCS_REF_URL;#var-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"
|