mirror of
https://git.yoctoproject.org/poky
synced 2026-05-31 03:52:39 +02:00
fa0cb4d34b
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>
200 lines
10 KiB
XML
200 lines
10 KiB
XML
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
|
|
[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
|
|
<!--SPDX-License-Identifier: CC-BY-2.0-UK-->
|
|
|
|
<chapter id='ref-varlocality'>
|
|
<title>Variable Context</title>
|
|
|
|
<para>
|
|
While you can use most variables in almost any context such as
|
|
<filename>.conf</filename>, <filename>.bbclass</filename>,
|
|
<filename>.inc</filename>, and <filename>.bb</filename> files,
|
|
some variables are often associated with a particular locality or context.
|
|
This chapter describes some common associations.
|
|
</para>
|
|
|
|
<section id='ref-varlocality-configuration'>
|
|
<title>Configuration</title>
|
|
|
|
<para>
|
|
The following subsections provide lists of variables whose context is
|
|
configuration: distribution, machine, and local.
|
|
</para>
|
|
|
|
<section id='ref-varlocality-config-distro'>
|
|
<title>Distribution (Distro)</title>
|
|
|
|
<para>
|
|
This section lists variables whose configuration context is the
|
|
distribution, or distro.
|
|
<itemizedlist>
|
|
<listitem><para><filename><link linkend='var-DISTRO'>DISTRO</link></filename></para></listitem>
|
|
<listitem><para><filename><link linkend='var-DISTRO_NAME'>DISTRO_NAME</link></filename>
|
|
</para></listitem>
|
|
<listitem><para><filename><link linkend='var-DISTRO_VERSION'>DISTRO_VERSION</link>
|
|
</filename></para></listitem>
|
|
<listitem><para><filename><link linkend='var-MAINTAINER'>MAINTAINER</link></filename>
|
|
</para></listitem>
|
|
<listitem><para><filename><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link>
|
|
</filename></para></listitem>
|
|
<listitem><para><filename><link linkend='var-TARGET_OS'>TARGET_OS</link></filename>
|
|
</para></listitem>
|
|
<listitem><para><filename><link linkend='var-TARGET_FPU'>TARGET_FPU</link></filename>
|
|
</para></listitem>
|
|
<listitem><para><filename><link linkend='var-TCMODE'>TCMODE</link></filename>
|
|
</para></listitem>
|
|
<listitem><para><filename><link linkend='var-TCLIBC'>TCLIBC</link></filename>
|
|
</para></listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
</section>
|
|
|
|
<section id='ref-varlocality-config-machine'>
|
|
<title>Machine</title>
|
|
|
|
<para>
|
|
This section lists variables whose configuration context is the
|
|
machine.
|
|
<itemizedlist>
|
|
<listitem><para><filename><link linkend='var-TARGET_ARCH'>TARGET_ARCH</link></filename>
|
|
</para></listitem>
|
|
<listitem><para><filename><link linkend='var-SERIAL_CONSOLES'>SERIAL_CONSOLES</link>
|
|
</filename></para></listitem>
|
|
<listitem><para><filename><link linkend='var-PACKAGE_EXTRA_ARCHS'>PACKAGE_EXTRA_ARCHS</link>
|
|
</filename></para></listitem>
|
|
<listitem><para><filename><link linkend='var-IMAGE_FSTYPES'>IMAGE_FSTYPES</link>
|
|
</filename></para></listitem>
|
|
<listitem><para><filename><link linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link>
|
|
</filename></para></listitem>
|
|
<listitem><para><filename><link linkend='var-MACHINE_EXTRA_RDEPENDS'>MACHINE_EXTRA_RDEPENDS
|
|
</link></filename></para></listitem>
|
|
<listitem><para><filename><link linkend='var-MACHINE_EXTRA_RRECOMMENDS'>MACHINE_EXTRA_RRECOMMENDS
|
|
</link></filename></para></listitem>
|
|
<listitem><para><filename><link linkend='var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS'>MACHINE_ESSENTIAL_EXTRA_RDEPENDS
|
|
</link></filename></para></listitem>
|
|
<listitem><para><filename><link linkend='var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'>
|
|
MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</link></filename></para></listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
</section>
|
|
|
|
<section id='ref-varlocality-config-local'>
|
|
<title>Local</title>
|
|
|
|
<para>
|
|
This section lists variables whose configuration context is the
|
|
local configuration through the <filename>local.conf</filename>
|
|
file.
|
|
<itemizedlist>
|
|
<listitem><para><filename><link linkend='var-DISTRO'>DISTRO</link></filename>
|
|
</para></listitem>
|
|
<listitem><para><filename><link linkend='var-MACHINE'>MACHINE</link></filename>
|
|
</para></listitem>
|
|
<listitem><para><filename><link linkend='var-DL_DIR'>DL_DIR</link></filename>
|
|
</para></listitem>
|
|
<listitem><para><filename><link linkend='var-BBFILES'>BBFILES</link></filename>
|
|
</para></listitem>
|
|
<listitem><para><filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES
|
|
</link></filename></para></listitem>
|
|
<listitem><para><filename><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link>
|
|
</filename></para></listitem>
|
|
<listitem><para><filename><link linkend='var-BB_NUMBER_THREADS'>BB_NUMBER_THREADS</link>
|
|
</filename></para></listitem>
|
|
<listitem><para><filename><link linkend='var-BBINCLUDELOGS'>BBINCLUDELOGS</link>
|
|
</filename></para></listitem>
|
|
<listitem><para><filename><link linkend='var-ENABLE_BINARY_LOCALE_GENERATION'>
|
|
ENABLE_BINARY_LOCALE_GENERATION</link></filename></para></listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
</section>
|
|
</section>
|
|
|
|
<section id='ref-varlocality-recipes'>
|
|
<title>Recipes</title>
|
|
|
|
<para>
|
|
The following subsections provide lists of variables whose context is
|
|
recipes: required, dependencies, path, and extra build information.
|
|
</para>
|
|
|
|
<section id='ref-varlocality-recipe-required'>
|
|
<title>Required</title>
|
|
|
|
<para>
|
|
This section lists variables that are required for recipes.
|
|
<itemizedlist>
|
|
<listitem><para><filename><link linkend='var-LICENSE'>LICENSE</link>
|
|
</filename></para></listitem>
|
|
<listitem><para><filename><link linkend='var-LIC_FILES_CHKSUM'>LIC_FILES_CHKSUM</link>
|
|
</filename></para></listitem>
|
|
<listitem><para><filename><link linkend='var-SRC_URI'>SRC_URI</link></filename> - used
|
|
in recipes that fetch local or remote files.
|
|
</para></listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
</section>
|
|
|
|
<section id='ref-varlocality-recipe-dependencies'>
|
|
<title>Dependencies</title>
|
|
|
|
<para>
|
|
This section lists variables that define recipe dependencies.
|
|
<itemizedlist>
|
|
<listitem><para><filename><link linkend='var-DEPENDS'>DEPENDS</link>
|
|
</filename></para></listitem>
|
|
<listitem><para><filename><link linkend='var-RDEPENDS'>RDEPENDS</link>
|
|
</filename></para></listitem>
|
|
<listitem><para><filename><link linkend='var-RRECOMMENDS'>RRECOMMENDS</link>
|
|
</filename></para></listitem>
|
|
<listitem><para><filename><link linkend='var-RCONFLICTS'>RCONFLICTS</link>
|
|
</filename></para></listitem>
|
|
<listitem><para><filename><link linkend='var-RREPLACES'>RREPLACES</link>
|
|
</filename></para></listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
</section>
|
|
|
|
<section id='ref-varlocality-recipe-paths'>
|
|
<title>Paths</title>
|
|
|
|
<para>
|
|
This section lists variables that define recipe paths.
|
|
<itemizedlist>
|
|
<listitem><para><filename><link linkend='var-WORKDIR'>WORKDIR</link>
|
|
</filename></para></listitem>
|
|
<listitem><para><filename><link linkend='var-S'>S</link>
|
|
</filename></para></listitem>
|
|
<listitem><para><filename><link linkend='var-FILES'>FILES</link>
|
|
</filename></para></listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
</section>
|
|
|
|
<section id='ref-varlocality-recipe-build'>
|
|
<title>Extra Build Information</title>
|
|
|
|
<para>
|
|
This section lists variables that define extra build information for recipes.
|
|
<itemizedlist>
|
|
<listitem><para><filename><link linkend='var-DEFAULT_PREFERENCE'>DEFAULT_PREFERENCE
|
|
</link></filename></para></listitem>
|
|
<listitem><para><filename><link linkend='var-EXTRA_OECMAKE'>EXTRA_OECMAKE</link>
|
|
</filename></para></listitem>
|
|
<listitem><para><filename><link linkend='var-EXTRA_OECONF'>EXTRA_OECONF</link>
|
|
</filename></para></listitem>
|
|
<listitem><para><filename><link linkend='var-EXTRA_OEMAKE'>EXTRA_OEMAKE</link>
|
|
</filename></para></listitem>
|
|
<listitem><para><filename><link linkend='var-PACKAGECONFIG_CONFARGS'>PACKAGECONFIG_CONFARGS</link>
|
|
</filename></para></listitem>
|
|
<listitem><para><filename><link linkend='var-PACKAGES'>PACKAGES</link></filename>
|
|
</para></listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
</section>
|
|
</section>
|
|
</chapter>
|
|
<!--
|
|
vim: expandtab tw=80 ts=4 spell spelllang=en_gb
|
|
-->
|