Commit Graph

2343 Commits

Author SHA1 Message Date
Michael Opdenacker
ba478645a3 manuals: add references to the "do_devshell" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 53141101fc1a8dc8b4007adcded3c7c6b9738f48)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
2aae1accee ref-manual: tasks.rst: add references to the "do_cleansstate" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 2d48187906e289caf33bf53e6ddecfe56f6fd74b)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
66a523d7e7 manuals: add references to the "do_cleanall" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 4c815875b7c716f421bbcd11ce26703867f11741)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
c9c7ace795 manuals: add references to the "do_unpack" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 1ca57f8ec322d5777bf31829e659d62e82986be1)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
a8b6712dfd manuals: add references to "do_populate_sysroot" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: a010e2eafa6754c46faac6f6dfd02dc6152d274f)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
2102333157 ref-manual: variables.rst: add reference to "do_populate_lic" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: b58444010ebe359d11884ad4bde505ccd1813e79)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
ec31647110 manuals: add references to "do_package_write_*" tasks
Using a reference to "do_package_write_deb", the first entry
in the list.

[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 237cebcfa6215d75bbe28df677f18ebf7e1bb4f6)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
a6a7676910 manuals: add references to the "do_patch" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 1e38ceafb25aac13bb9dd45626fd39ad1b68852d)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:25 +01:00
Michael Opdenacker
67a72fc3f7 manuals: add references to the "do_package_qa" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: af27370fd4ffd0e0455187aa9fc5349d39403ae7)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:25 +01:00
Michael Opdenacker
b3dc55b051 manuals: add references to the "do_package" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 179139e6710f6dde0de25200c372705ed8ef13bc)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:25 +01:00
Michael Opdenacker
3c6b2798a0 manuals: add references to the "do_image" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 2f53d0a52a48f828f00d3bc3f887fd537692a256)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:25 +01:00
Michael Opdenacker
0e8d0ecc6c manuals: add references to the "do_deploy" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: b607a0578e8edd3e4ee013b4438481cb82bc106e)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:25 +01:00
Michael Opdenacker
6ade5d2d0e manuals: add reference to the "do_compile" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: e88f11002032e30bbe2dd0049e307a431a70aaef)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:25 +01:00
Michael Opdenacker
5d1e8104cd manuals: add reference to "do_configure" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 5ddc1a40c9004d814472bdd385f456afa7a9c4e3)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:25 +01:00
Michael Opdenacker
9fece9c361 manuals: add reference to the "do_install" task
[YOCTO #14508]
(From yocto-docs rev: 933ad27b81dfc4a28e7c48ca7bb2d1363e8c037f)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:25 +01:00
Michael Opdenacker
9dbd27a48a manuals: improve initramfs details
- Create a new entry in the glossary
- Add implementation details
- Replace the mention of "init ramdisk" by "initramfs¨
  whenever possible
- Remove obsolete and duplicate information
- Fix spacing issues in the Sphinx code

(From yocto-docs rev: 952c7e6dee49532705b2c162f4728e635c38df3f)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:25 +01:00
Michael Opdenacker
e2ead243cd ref-manual: structure.rst: add more subsection levels
To better reflect the subdirectory structure,
as suggested in [YOCTO #14543]

(From yocto-docs rev: a35d1b546c219407bc93c87789a7147a9ade270e)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-09-24 17:44:56 +01:00
Michael Opdenacker
1bdbc6c926 ref-manual: variables.rst: correct templateconf.cfg file name
According to code in
https://git.openembedded.org/openembedded-core/tree/meta/classes-recipe/populate_sdk_ext.bbclass

(From yocto-docs rev: 454a828103aeb9b3ad3985f07d89f418213f5471)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-09-24 17:44:56 +01:00
Michael Opdenacker
79b0386676 ref-manual: structure.rst: improve information about build/cache/
Also include this directory in alphabetical order.

(From yocto-docs rev: f9156f413053a5f19bd59c83a1f6f24eb02a57e1)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-09-24 17:44:56 +01:00
Michael Opdenacker
388d2c767c ref-manual: structure.rst: add reference to the contents of the build directory
Add this to the quick description of build/ in the toplevel
directory structure.

(From yocto-docs rev: 380143e2c47afb613e45e9cd664e298738f858fa)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-09-24 17:44:56 +01:00
Michael Opdenacker
2311ec16a5 ref-manual: variables.rst: remove BBPATH
As reported in [YOCTO #14502], the description of BBPATH in the
Yocto Project Manual is redundant with its description in the
BitBake User Manual.

(From yocto-docs rev: 5feb4e174e0aec6a48b1131889a5b8547b9b9921)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-09-24 17:44:56 +01:00
Michael Opdenacker
ec447505b2 ref-manual: features.rst: add missing default distro features
Document default machine features defined in Poky, and which
were not listed in the documentation yet.

Took the values of DISTRO_FEATURES_DEFAULT and POKY_DEFAULT_DISTRO_FEATURES:
meta-poky/conf/distro/poky.conf:DISTRO_FEATURES ?= "${DISTRO_FEATURES_DEFAULT} ${POKY_DEFAULT_DISTRO_FEATURES}"

Also explain that extra layers can define their own features.

This addresses [YOCTO #14515]

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-09-24 17:44:56 +01:00
Johan Korsnes
c66e7b9479 ref-manual: variables: document KERNEL_IMAGETYPES
Cc: He Zhe <zhe.he@windriver.com>
Cc: Ross Burton <ross.burton@arm.com>
Cc: Richard Purdie <richard.purdie@linuxfoundation.org>
(From yocto-docs rev: aef81b8d19a31dcd1eef5a0023f43d81875ca215)

Signed-off-by: Johan Korsnes <johan.korsnes@remarkable.no>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-09-24 17:44:56 +01:00
Alexander Kanavin
93e27bdb15 ref-manual: correct the location of default configuration template
(From yocto-docs rev: 4f42ccd877162d3ea498bd91a194e810d3f61292)

Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-09-24 17:44:55 +01:00
Ulrich Ölmann
b26546f537 manuals: fix typos in the context of 'icecc' & clean up whitespaces
(From yocto-docs rev: cce3eece0886b5446774e6a5cc57c28d13c58fdd)

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-09-24 17:44:55 +01:00
Khem Raj
a79e1bb7ab ref-manual: Define TC_CXX_RUNTIME
This variable is used to denote the C/C++ compiler runtime to use.
Right now there are few alternatives out of the core which could
use this variable to define this property, the values it can take
are 'gnu' for gcc runtime. 'llvm' for using compiler-rt+libc++ and
'android' to use android runtime. Default settings is to use gnu
which is current silent default also.

(From yocto-docs rev: 9094510e08b3a7b215b0d3ebecf66475a57b4c7e)

Signed-off-by: Khem Raj <raj.khem@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-09-24 17:44:55 +01:00
Ulrich Ölmann
05270ae200 manuals: fix paths to default templates & clean up whitespaces
The templates have recently been moved by meta-yocto's commit [1].
Clean up some whitespace issues along the way.

[1] 29608bd03e1b ("meta-poky/conf: move default templates to conf/templates/default/")

(From yocto-docs rev: 661c554224dd79e79afd22b84608e248d3336aac)

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-09-12 08:35:17 +01:00
Jon Mason
0f8549bf9f ref-manual: add numa to machine features
numa is an existing machine feature, add it to the list so that users
are aware of it.

(From yocto-docs rev: 6022d15b8ee5e038d2f1c0f061a871dba40e5213)

Signed-off-by: Jon Mason <jdmason@kudzu.us>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-08-31 12:17:45 +01:00
Armin Kuster
f7763317f8 system-requirements.rst: remove EOL and Centos7 hosts
Commit https://git.yoctoproject.org/poky/commit/?id=d08e47312741a18e7be505d22762b90528253ac9
removed some EOL and CentOS7 from list hos supported hosts. Sync docs with Poky
Replace CentOS with AlmaLinux.

(From yocto-docs rev: 25a0e14ee8da9f59fa50ec209478e08e6438b827)

Signed-off-by: Armin Kuster <akuster808@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-08-12 23:11:28 +01:00
Quentin Schulz
3eb3888ef0 docs: ref-manual: system-requirements: add missing packages
inkscape and the package providing fncychap.sty TeX font were missing
from the packages to install to be able to build the documentation, so
let's add them to the list.

Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 4c05a45615ef2b13e9af4b792fb97be116d889b1)

Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-08-12 23:11:28 +01:00
Quentin Schulz
102278a77f docs: ref-manual: variables: remove sphinx directive from literal block
Literal blocks make sphinx take their text verbatim. This means that
directives cannot be used in literal blocks. This means :term:`S` was
printed as-is, without actually creating a link to the S variable
definition as would be expected outside of literal blocks.

Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: ca5e076a413b0e1241eefdfccfee5bfa652cf6f8)

Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-07-20 14:25:01 +01:00
Aatir Manzur
8152025572 ref-manual: Sphinx note directive for DISTRO_FEATURES definition
(From yocto-docs rev: 1f175da06ecbed3ebb0621a0625010e43d916a3a)

Signed-off-by: Aatir Manzur <aatrapps@gmail.com>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-07-20 14:25:01 +01:00
Ross Burton
e1346989da documentation: remove obsolete PEP517_BUILD_API
This variable has been obsoleted, so remove it from the documentation.

(From yocto-docs rev: 30ed4323e7fb482e4f6f47755314354a2e5e3871)

(From yocto-docs rev: afa895871e8ec18f4861f48f70b8a54cc2e4cb98)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-07-15 12:30:32 +01:00
Aatir Manzur
9900bb5d13 docs: add CONVERSION_CMD definition
(From yocto-docs rev: 05d376ccc65510a7d636e2685fb92a48d4712b0b)

Signed-off-by: Aatir Manzur <aatrapps@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-06-30 17:09:51 +01:00
Michael Opdenacker
d9adf28c10 manuals: replace hyphens with em dashes
Fix some hyphens being improperly used as em dashes.
See https://www.grammarly.com/blog/hyphens-and-dashes/

Using em dashes may also allow Sphinx to hyphenate
and break lines in the best way.

Note that the first character after an em dash not
supposed to be capitalized, unless a specific
rule applies, typically when what follows is a proper noun.

Fix a few misuses of parentheses in following text.

(From yocto-docs rev: 5918f019f63f6e820b1168f4cc001faa1d1cdc6f)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-06-27 14:55:08 +01:00
Peter Kjellerstedt
c4f669566f ref-manual: Add documentation for INCOMPATIBLE_LICENSE_EXCEPTIONS
(From yocto-docs rev: 2a7732bce71b4a493f6bb081b545de6ac586b88a)

Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-06-27 14:55:08 +01:00
aatir
22a70fbc3e docs: make DISTRO_FEATURES description more explicit
Make DISTRO_FEATURES description more explicit by specifying
that DISTRO_FEATURES alone can't select build configurations,
and need mechanisms like PACKAGECONFIG setup to take care of
selecting build configurations.

Signed-off-by Aatir Manzur <aatrapps@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>

(From yocto-docs rev: 4b39a4434ee658512050c50f6ebd5ad5dc900fb1)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-06-27 14:55:08 +01:00
Michael Opdenacker
e816f39696 ref-manual: correct description of empty-root-passwd in IMAGE_FEATURES
"empty-root-passwd" doesn't actually set an empty root password.
It just doesn't touch the initial root password which is empty by default.

(From yocto-docs rev: 793cfe841148ead7e22fc2caf045247ab27a15da)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-06-21 20:57:17 +01:00
Michael Opdenacker
63a341f385 ref-manual: IMAGE_FEATURES: add allow-root-login and correct allow-empty-password
Completing the descriptions of "debug-tweaks".
Correcting the description of "allow-empty-password"
which doesn't imply accepting root logins.

(From yocto-docs rev: 907c94886fd8a485a6045d71478e41a3c598821c)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-06-21 20:57:17 +01:00
Michael Opdenacker
1fa6a9bbb7 ref-manual: document SYSTEMD_DEFAULT_TARGET
[YOCTO #14660]

(From yocto-docs rev: d5bcdf9a8b357b96656b62c41834410e662d8546)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-06-21 20:57:17 +01:00
Michael Opdenacker
c1d1cdcedf ref-manual: document SSTATE_EXCLUDEDEPS_SYSROOT
[YOCTO #14496]

(From yocto-docs rev: b6690011c14ce4bf30571f045152a9d324ad5039)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-06-21 20:57:17 +01:00
Michael Opdenacker
f7f4444e36 manuals: update host tool requirements
As enforced by meta/classes/sanity.bbclass:
- at least GNU make 4.0
- at least GNU tar 7.5 (instead of 5.0)

(From yocto-docs rev: 6480aa0f8338ef192c666b9445bc0baff47d9248)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-06-21 20:57:17 +01:00
Michael Opdenacker
50acfba977 ref-manual: add description for the "sysroot" term
This term is used throughout the manual but is not properly
introduced anywhere.

(From yocto-docs rev: 51426a0762a5988aa835e065f5258fd7ac474c52)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-06-21 20:57:17 +01:00
Richard Purdie
a7c0424467 ref/dev-manual: Update multiconfig documentation
Multiconfigs now work from layers. Update the documentation to match this change.
Also fix a incorrect reference to different distros working within the same TMPDIR,
that is incorrect.

[YOCTO #13566]

(From yocto-docs rev: cb35f75bfc98c9098f9af64b9dd040b25779da36)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-06-21 20:57:16 +01:00
Paulo Neves
8b01f7811f ref-manual: SYSTEMD_SERVICE overrides depend on SYSTEMD_PACKAGES
Add detail that package overrides are only available if
specified in SYSTEMD_PACKAGES.

(From yocto-docs rev: 9466c0b79348e68b1db7aefd3d95f8e7c903f1d4)

Signed-off-by: Paulo Neves <ptsneves@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-06-21 20:57:16 +01:00
Paulo Neves
ac1ec0d1ea ref-manual: SYSTEMD_SERVICE allows multiple services
State that SYSTEMD_SERVICE allows for multiple space
separated systemd services

(From yocto-docs rev: 68f7009b06007b925e7a5b6ab085ec813d85b0bc)

Signed-off-by: Paulo Neves <ptsneves@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-06-21 20:57:16 +01:00
Michael Opdenacker
b192b80593 manuals: add documentation for WKS_FILES
Fixes [YOCTO #14590]

(From yocto-docs rev: e736ff92b5b09f2028f3e8a5152973941d25dae4)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-05-24 13:58:47 +01:00
Michael Opdenacker
51cb0db138 manuals: add missing space in appends
(From yocto-docs rev: aa122d28298596a3b91a8f6650163785a3cfa831)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-05-24 13:58:47 +01:00
Michael Opdenacker
76ae677313 manuals: improve documentation for TEMPLATECONF
Add it to the variable index
Misc improvements to the documentation for this variable

(From yocto-docs rev: fb460a7c7aba1ad5754806f9cfad9ef591420317)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-05-10 12:52:35 +01:00
Michael Opdenacker
14c7cd24a5 manuals: improve the width of diagrams
Better for EPUB output in particular
- Make some diagrams wider when necessary
- Remove ":align: center" when we have ":width: 100%"
- Update the standards.md files to mention this

(From yocto-docs rev: 848ba7bd8984cc3f4bf6b818259865011cde0476)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-05-10 12:52:35 +01:00
Michael Opdenacker
eae7c2a0c2 manuals: fix name capitalization issues
- Using "BitBake" instead of "Bitbake" or "bitbake", aligning with the
  title of the "BitBake User Manual".
- Using "OpenEmbedded" instead of "Openembedded"
- Using "Python" instead of "python"

(From yocto-docs rev: 0b893e2a15aefedd7100445fc9d7eeed07b6afc6)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-05-10 12:52:34 +01:00
Michael Opdenacker
a19ee03611 manuals: correct and improve descriptions of Autotools
(From yocto-docs rev: c7cb693673566ec12b95c568945b514ed0e18522)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-27 16:02:39 +01:00
Quentin Schulz
78874e0126 docs: ref-manual: variables: add hashed password example in EXTRA_USERS_PARAMS
Add examples for hashed hardcoded passwords from extrausers.bbclass so
that this feature is not hidden away.

Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 5db73c7c5668144ed4629f95378e44f0bd8c8256)

Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-25 15:14:09 +01:00
Paul Eggleton
d653a43665 ref-manual: add ZSTD_THREADS
ZSTD_THREADS is new for kirkstone.

(From yocto-docs rev: b970936b89bebb184c82be3a9514a9eba7c04f9b)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-25 15:14:09 +01:00
Richard Purdie
e2cb52612e ref-manual: Add XZ_THREADS and XZ_MEMLIMIT
XZ_THREADS and XZ_MEMLIMIT were introduced in dunfell.

[RP improved an original patch from Paul]
(From yocto-docs rev: 96defb66b775093b5270bd1ebad0461c2bba1e5b)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-25 15:14:09 +01:00
Paul Eggleton
d89fbdfd16 ref-manual: add empty-dirs QA check and QA_EMPTY_DIRS*
This check is new in kirkstone.

(From yocto-docs rev: baa483e75538013be3261f8c115b8a5364b24c60)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-25 15:14:09 +01:00
Paul Eggleton
c3067e46c0 ref-manual: add KERNEL_DEBUG_TIMESTAMPS
New variable in kirkstone.

(From yocto-docs rev: 2c5d4938a09fd35f9e86f682cde89d4693762725)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-25 15:14:08 +01:00
Paul Eggleton
71fafac324 ref-manual: add mention of vendor filtering to CVE_PRODUCT
Mention the vendor filtering functionality - prompted by OE-Core
revision 45d1a0bea0c628f84a00d641a4d323491988106f.

(From yocto-docs rev: 13ff5a49f14a26772b4775d9ecd08627e6becd4d)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-25 15:14:08 +01:00
Paul Eggleton
0dd9a182ac ref-manual: mention wildcarding support in INCOMPATIBLE_LICENSE
Add this since the INCOMPATIBLE_LICENSE wildcard support has changed in
the 4.0 release.

(From yocto-docs rev: c7946863e5a9d62a49131b92cc9549da9b799bbd)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-25 15:14:08 +01:00
Paul Eggleton
30b4b153d6 ref-manual: add a note about hard-coded passwords
It seems prudent to point out that hard-coding passwords in the manner
detailed in the example is not a good idea in production. This type of
mistake has unfortunately been made by many device vendors (outside of
the Yocto Project context) leading to security vulnerabilities.

(From yocto-docs rev: 1d07dba9423ae0a841eccb58c297e31b63c3965d)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-25 15:14:08 +01:00
Michael Opdenacker
325c23cd0f manuals: fix quoting of double dashes
Otherwise rendered as "en" dashes by sphinx, for example:
git pull –rebase
instead of
git pull --rebase

Readers could confuse them with normal dashes.

Exception: replace by \-\- in italic text (*text*)
as Sphinx cannot nest italic and quoted text.

For consistency, also update quoting in strings in the same code hunks.

(From yocto-docs rev: 4e7ce372e37f76148f623a5295a15e08bc2603ff)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-31 11:46:03 +01:00
Daniel Ammann
e16ad94999 ref-manual: Add vfat in list of filesystems supported by kickstart
(From yocto-docs rev: 6e09a7eb190c412fa282bde128a6f8f1b24fd713)

Signed-off-by: Daniel Ammann <daniel.ammann@bytesatwork.ch>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-31 11:46:03 +01:00
Peter Kjellerstedt
c3b7982d20 ref-manual: Remove references to AVAILABLE_LICENSES
The AVAILABLE_LICENSES variable has been removed from OE-Core.

(From yocto-docs rev: dd687b10e1a21222e8dcc3be29635fd3200a205b)

Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-31 11:46:03 +01:00
Ross Burton
f4549231b2 ref-manual: update Python class documentation
Add new PEP517_* variables, remove obsolete variables, and update for
renamed classes.

(From yocto-docs rev: 3984d4d0804125ba6fba7bf712edb81f97b4bec7)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-31 11:46:03 +01:00
Richard Purdie
33083dd825 poky.yaml: Drop POKYVERSION and YOCTO_POKY references
We don't publish tarballs using this version any more, it has been
removed everywhere. Remove the obsolete references in the docs,
adapting references accordingly. The tarballs now are just created
with their sha256 checksum which we don't want or need to reference
in the docs.

(From yocto-docs rev: c7a0ac88b01c48f3d9209536542bf43ae7a7937f)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-21 15:18:24 +00:00
Michael Opdenacker
d5663dd9cd ref-manual: reorder variable definitions
By alphabetical order, to get the same order as in the HTML
output, sorted thanks to the ":sorted:" directive.

That was needed after the recent variable renaming for
inclusive language, but other variables were already
out of order anyway.

(From yocto-docs rev: 371c30d2f95fa32239c82d4ad8a6329ab191acca)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-16 14:25:02 +00:00
Michael Opdenacker
adbd2348c4 ref-manual: sort list of variables in generated output
As already done in the BitBake manual.

Even though we're trying to keep the variable
definitions in alphabetical order, it's useful
to make sure that the variables are ordered in the
generated output.

(From yocto-docs rev: a43887858f46d2870443f7664487a36def23a90e)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-16 14:25:02 +00:00
Michael Opdenacker
81664f1adc docs: ref-system-requirements.rst: update list of supported distros
Add AlmaLinux 8.5, Fedora 35, and OpenSUSE Leap 15.3
Remove Fedora 33, Debian 8, OpenSUSE Leap 15.1 and 15.2

Removing distros that were recently removed from SANITY_TESTED_DISTROS
in meta-poky/conf/distro/poky.conf

(From yocto-docs rev: 734d5db1f166d7722541b25718fb11a12282f0c5)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Steve Sakoman <steve@sakoman.com>
Reported-by: Christian Eggers <ceggers@arri.de>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-16 14:25:02 +00:00
Ross Burton
4b15900ee0 Update documentation for Python packaging changes
A number of classes and variables have been renamed, so update the
documentation as needed.

(From yocto-docs rev: 35b2e1757f5f2f09bb899ed24ffea50e5041b471)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-16 14:25:02 +00:00
Michael Opdenacker
809b96e931 manuals: inclusive language updates
Changes identified by OE core's
scripts/contrib/convert-variable-renames.py script

Original variable names are kept in old migration notes,
but references to the new ones are provided.

(From yocto-docs rev: 1a35380ca80509fee036018a2bbb22ba9b44d47a)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-16 14:25:01 +00:00
Michael Opdenacker
bafbbd53c4 docs: update examples to add branch info to git URIs
Branch information is now mandatory for git:// and gitsm:// URIs

(From yocto-docs rev: b862655d812e358dd15b06c0548a276a90666423)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-16 14:25:01 +00:00
Christian Eggers
16831cd62b ref-manual: INCOMPATIBLE_LICENSE: use new license wildcards
This has recently been changed in expand_wildcard_licenses().
(file: OECORE/meta/classes/license.bbclass).

(From yocto-docs rev: 5121da30350a4edeef07f6722222c9e364617f0e)

Signed-off-by: Christian Eggers <ceggers@arri.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-16 14:25:01 +00:00
Saul Wold
7c617ecb4d documentation: Update for skip_recipe rename
This change better aligns the name of the variable with its
purpose. Since we removed the older class, the associated
documentation is also removed.

(From yocto-docs rev: aa136a0fb552339db5475fff7947d2248f8af3e1)

Signed-off-by: Saul Wold <saul.wold@windriver.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-16 14:25:01 +00:00
Michael Opdenacker
6df5aa3475 documentation: remove references to prelink support
Fixing documentation and updating examples containing "prelink"
in their output.

(From yocto-docs rev: 8927b8fff55fac1bd1fefcff2d16141dbd1ebc51)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-04 09:39:37 +00:00
Quentin Schulz
0966ba1ebb ref-manual: classes: provide command with ready-to-use password
mkpasswd output requires to be escaped before being used as password in
a Bitbake variable. It was explicitly stated after the command, but to
be sure it's not missed, let's give the printf command which does escape
the string for us.

Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 13064e7bea18e999d4a294e298a7980a4dcbe69e)

Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-04 09:39:37 +00:00
Tim Orling
61ee42131c docs: add pip install variables
Add the new variables used to install Python `wheel` binary archives:
* PIP_INSTALL_ARGS
* PIP_INSTALL_DIST_PATH
* PIP_INSTALL_PACKAGE
* PYPA_WHEEL

(From yocto-docs rev: cb213b5682e37873ac0ec457d6f5a52639c4b24a)

Signed-off-by: Tim Orling <tim.orling@konsulko.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-04 09:39:37 +00:00
Tim Orling
6f2365a292 docs: add new python packaging classes
Add the new classes used for Python packaging:
* flit_core
* pip_install_wheel
* setuptools_build_meta

(From yocto-docs rev: f78fe71f634cbf39857c42e90f8c16e511ba2076)

Signed-off-by: Tim Orling <tim.orling@konsulko.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-04 09:39:37 +00:00
Tim Orling
5bf8da73bb docs: ref-manual: remove distutils* from classes
The distutils*.bbclasses have been removed from oe-core and moved to
meta-python, so remove them from ref-manual/classes.rst.

(From yocto-docs rev: 9da8fd7d436ac3eb3b66409cf0e53218d6e41822)

Signed-off-by: Tim Orling <tim.orling@konsulko.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-04 09:39:37 +00:00
Tim Orling
3848535523 docs: ref-manual: drop distutils from variables
The distutils*.bbclasses have been moved to meta-python, so remove
mention of them from ref-manual/variables.rst

(From yocto-docs rev: af3d465c5d50edd27957c205dd26aae6843ee3b2)

Signed-off-by: Tim Orling <tim.orling@konsulko.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-04 09:39:37 +00:00
Peter Kjellerstedt
865e150599 manuals: Update LICENSE vars in examples to use SPDX license identifiers
This is similar to the recent change in meta to only use SPDX license
identifiers in the recipes.

(From yocto-docs rev: 147ce973d08f0bfb59b7b87fec8c8cc997d57112)

Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-04 09:39:37 +00:00
Tim Orling
99a5b42d5c docs: update setuptools3 class
Add notes to inform about the new `wheel` behavior of the
setuptools3.bbclass.

(From yocto-docs rev: 4f19c8218f7c960d1ad0288d76d5394b6595c3f1)

Signed-off-by: Tim Orling <tim.orling@konsulko.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-04 09:39:37 +00:00
Quentin Schulz
89544cf511 docs: fix hardcoded link warning messages
Sphinx complains about hardcoded links which can be replaced by an
extlink.

So let's apply its recommendations.

Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: dc2ec13cfbe0f20a868108a0bd800c0a875c1796)

Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-02-23 18:12:10 +00:00
Quentin Schulz
4dbb515327 docs: point to renamed BB_BASEHASH_IGNORE_VARS variable
Since commit 98b3ed1b2e "meta/scripts: Handle bitbake variable
renaming", the new name of the variable is BB_BASEHASH_IGNORE_VARS
so let's update it so that Sphinx can resolve the Bitbake reference.

Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: a6c6283e9cc30ca580f1719d8e22fca5f79c1e50)

Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-02-23 18:12:10 +00:00
Peter Kjellerstedt
cd823f21f8 manuals: Remove unnecessary \n from SSTATE_MIRRORS examples
Since commit 044fb04d in bitbake (fetch2: Allow whitespace only mirror
entries) there is no need to separate the entries in SSTATE_MIRRORS
with "\n".

(From yocto-docs rev: 87b34b69b2df72d4e6edbd81839622fffd560331)

Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-02-20 15:36:13 +00:00
Michael Opdenacker
4407025996 ref-manual: update TCLIBC description
Stop mentioning the long gone POKYLIBC variable and fix punctuation

(From yocto-docs rev: d90be3bbfd45317ce07d1715af3d65ffb1e24ac7)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-02-18 17:58:02 +00:00
Alejandro Hernandez Samaniego
552ff6e3d5 documentation: Add multiconfig initramfs configuration:
dev-manual/common-tasks.rst: Add section to create an initramfs
image from a separate multiconfig.

ref-manual/variables.rst: Add new variable definitions for
INITRAMFS_DEPLOY_DIR_IMAGE and INITRAMFS_MULTICONFIG

(From yocto-docs rev: 7853ab3df82c27ba309879a66a084b2e597dc1e5)

Signed-off-by: Alejandro Enedino Hernandez Samaniego <alhe@linux.microsoft.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-02-18 17:58:02 +00:00
Michael Opdenacker
472a99447f ref-manual: add usage details about ccache.bbclass
(From yocto-docs rev: c06e5710b139c01347b9cd2113dde0961f483995)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-02-03 13:47:50 +00:00
Michael Opdenacker
de069431bf manuals: propose https for SSTATE_MIRRORS
Both http and https work, but https should raise fewer questions
from users.

(From yocto-docs rev: e3bf892b1328b5c43ab041ba6c850e2782f54bdf)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-02-03 13:47:50 +00:00
Michael Opdenacker
3a6185404e manuals: improve references to classes
- Simplify references to class sections, by replacing references such as
  :ref:`image.bbclass <ref-classes-image>`
  by
  :ref:`ref-classes-image`

  That's equivalent, because the class sections always called <class>.bbclass

- Adding references to class sections, by replacing strings such as
  ``image.bbclass``
  by
  :ref:`ref-classes-image`

- Simplifying a few class section links

(From yocto-docs rev: 29d66aaa898390c19f121baf0f4fdcc178e4cd80)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-02-03 13:47:50 +00:00
Michael Opdenacker
d8ddafdbff ref-manual: Drop TUNEABI, TUNEABI_WHITELIST, TUNEABI_OVERRIDE
Following their removal from openembedded-core

(From yocto-docs rev: bf98f5a15c33e75315cd14e653f253ef078da614)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-17 11:59:50 +00:00
Tim Orling
6d0dd8a635 ref-manual/classes.rst: add setuptools3-base
Add setuptools3-base class

Deprecate distutils3* classes.

[YOCTO #14610]

(From yocto-docs rev: 0e9838e5a2096932d081a9a05a25c4fa0d6dc714)

Signed-off-by: Tim Orling <tim.orling@konsulko.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-17 11:59:50 +00:00
Tim Orling
9d9a50aa14 ref-manual/variables.rst: add SETUPTOOLS_*_ARGS
Add SETUPTOOLS_BUILD_ARGS variable which can be used to pass additional
arguments to `setup.py build`.

Add SETUPTOOLS_INSTALL_ARGS variable which can be used to pass
additional arguments to `setup.py install`.

[YOCTO #14610]

(From yocto-docs rev: 4e8c911b73f511f1fb7b557f12d5c87129bc2593)

Signed-off-by: Tim Orling <tim.orling@konsulko.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-17 11:59:50 +00:00
Tim Orling
7018f99223 ref-manual/variables.rst: add SETUPTOOLS_SETUP_PATH
Add SETUPTOOLS_SETUP_PATH for setuptools3 class.

Deprecate DISTUTILS_SETUP_PATH and drop mention of ref-classes-setuptools3 as
that class has moved to new variable.

[YOCTO #14610]

(From yocto-docs rev: 6a314a9217206f572289b484e59076483391868c)

Signed-off-by: Tim Orling <tim.orling@konsulko.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-17 11:59:50 +00:00
Michael Opdenacker
fc30301d4c manuals: simplify references to class sections
Replace
":ref:`classname.bbclass <ref-classes-classname>`" section
by
":ref:`ref-classes-classname`" section
because each section has "classname.bbclass" as title,
therefore the result is the same.

(From yocto-docs rev: e3f438e4a71b155bd09bc7988c8e5626a063fde3)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-17 11:59:50 +00:00
Michael Opdenacker
0f8337865f manuals: add reference to GIR_EXTRA_LIBS_PATH plus minor improvements
Fixes [YOCTO #14533]

(From yocto-docs rev: 84001d5d4258dad9e3663ea842ecc291d9e1a7dd)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-10 23:12:43 +00:00
Max Krummenacher
22075d91d6 ref-manual: fix patch documentation
The do_patch implementation does not apply patches from an entry in
SRC_URI pointing to a directory.
Remove the claim that this is implemented.

(From yocto-docs rev: de1156b6d95a2d1738807f0b0525edd0b58fc0e9)

Signed-off-by: Max Krummenacher <max.krummenacher@toradex.com>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-07 11:12:06 +00:00
Robert Joslyn
3182ba8142 ref-manual: Fix module_conf typo
Modules specified as part of module_conf must be listed in
KERNEL_MODULE_PROBECONF, not KERNEL_MODULE_AUTOLOAD.

(From yocto-docs rev: 5720fb534dc343675f8be6369b9661512e3968f2)

Signed-off-by: Robert Joslyn <robert.joslyn@redrectangle.org>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-07 11:12:06 +00:00
Michael Opdenacker
36d200ab0a manuals: replace "rootfs" by "root filesystem"
Almost everyone understands "rootfs", but "root filesystem"
is real English.

(From yocto-docs rev: 3d610f15e5b6be3435e9e81e4498a676671e5b39)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-07 11:12:06 +00:00
Vyacheslav Yurkov
5ec29c558f ref-manual: document overlayfs-etc image feature
(From yocto-docs rev: 62c7cea1b916c04bfd5c25e0011424b90d5272a1)

Signed-off-by: Vyacheslav Yurkov <uvv.mail@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-07 11:12:06 +00:00
Vyacheslav Yurkov
4b2d79d740 ref-manual: add overlayfs-etc class
(From yocto-docs rev: c11da26609e02f0c0b43efacb4642141d990ebaa)

Signed-off-by: Vyacheslav Yurkov <uvv.mail@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-07 11:12:06 +00:00