mirror of
https://git.yoctoproject.org/poky
synced 2026-05-01 15:32:12 +02: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>
165 lines
2.6 KiB
ReStructuredText
165 lines
2.6 KiB
ReStructuredText
****************
|
|
Variable Context
|
|
****************
|
|
|
|
While you can use most variables in almost any context such as
|
|
``.conf``, ``.bbclass``, ``.inc``, and ``.bb`` files, some variables are
|
|
often associated with a particular locality or context. This chapter
|
|
describes some common associations.
|
|
|
|
.. _ref-varlocality-configuration:
|
|
|
|
Configuration
|
|
=============
|
|
|
|
The following subsections provide lists of variables whose context is
|
|
configuration: distribution, machine, and local.
|
|
|
|
.. _ref-varlocality-config-distro:
|
|
|
|
Distribution (Distro)
|
|
---------------------
|
|
|
|
This section lists variables whose configuration context is the
|
|
distribution, or distro.
|
|
|
|
- ``DISTRO``
|
|
|
|
- ``DISTRO_NAME``
|
|
|
|
- ``DISTRO_VERSION``
|
|
|
|
- ``MAINTAINER``
|
|
|
|
- ``PACKAGE_CLASSES``
|
|
|
|
- ``TARGET_OS``
|
|
|
|
- ``TARGET_FPU``
|
|
|
|
- ``TCMODE``
|
|
|
|
- ``TCLIBC``
|
|
|
|
.. _ref-varlocality-config-machine:
|
|
|
|
Machine
|
|
-------
|
|
|
|
This section lists variables whose configuration context is the machine.
|
|
|
|
- ``TARGET_ARCH``
|
|
|
|
- ``SERIAL_CONSOLES``
|
|
|
|
- ``PACKAGE_EXTRA_ARCHS``
|
|
|
|
- ``IMAGE_FSTYPES``
|
|
|
|
- ``MACHINE_FEATURES``
|
|
|
|
- ``MACHINE_EXTRA_RDEPENDS``
|
|
|
|
- ``MACHINE_EXTRA_RRECOMMENDS``
|
|
|
|
- ``MACHINE_ESSENTIAL_EXTRA_RDEPENDS``
|
|
|
|
- ``MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS``
|
|
|
|
.. _ref-varlocality-config-local:
|
|
|
|
Local
|
|
-----
|
|
|
|
This section lists variables whose configuration context is the local
|
|
configuration through the ``local.conf`` file.
|
|
|
|
- ``DISTRO``
|
|
|
|
- ``MACHINE``
|
|
|
|
- ``DL_DIR``
|
|
|
|
- ``BBFILES``
|
|
|
|
- ``EXTRA_IMAGE_FEATURES``
|
|
|
|
- ``PACKAGE_CLASSES``
|
|
|
|
- ``BB_NUMBER_THREADS``
|
|
|
|
- ``BBINCLUDELOGS``
|
|
|
|
- ``ENABLE_BINARY_LOCALE_GENERATION``
|
|
|
|
.. _ref-varlocality-recipes:
|
|
|
|
Recipes
|
|
=======
|
|
|
|
The following subsections provide lists of variables whose context is
|
|
recipes: required, dependencies, path, and extra build information.
|
|
|
|
.. _ref-varlocality-recipe-required:
|
|
|
|
Required
|
|
--------
|
|
|
|
This section lists variables that are required for recipes.
|
|
|
|
- ``LICENSE``
|
|
|
|
- ``LIC_FILES_CHKSUM``
|
|
|
|
- ``SRC_URI`` - used in recipes that fetch local or remote files.
|
|
|
|
.. _ref-varlocality-recipe-dependencies:
|
|
|
|
Dependencies
|
|
------------
|
|
|
|
This section lists variables that define recipe dependencies.
|
|
|
|
- ``DEPENDS``
|
|
|
|
- ``RDEPENDS``
|
|
|
|
- ``RRECOMMENDS``
|
|
|
|
- ``RCONFLICTS``
|
|
|
|
- ``RREPLACES``
|
|
|
|
.. _ref-varlocality-recipe-paths:
|
|
|
|
Paths
|
|
-----
|
|
|
|
This section lists variables that define recipe paths.
|
|
|
|
- ``WORKDIR``
|
|
|
|
- ``S``
|
|
|
|
- ``FILES``
|
|
|
|
.. _ref-varlocality-recipe-build:
|
|
|
|
Extra Build Information
|
|
-----------------------
|
|
|
|
This section lists variables that define extra build information for
|
|
recipes.
|
|
|
|
- ``DEFAULT_PREFERENCE``
|
|
|
|
- ``EXTRA_OECMAKE``
|
|
|
|
- ``EXTRA_OECONF``
|
|
|
|
- ``EXTRA_OEMAKE``
|
|
|
|
- ``PACKAGECONFIG_CONFARGS``
|
|
|
|
- ``PACKAGES``
|