Commit Graph

305 Commits

Author SHA1 Message Date
Michael Opdenacker
dbcb74ef81 manuals: document VIRTUAL-RUNTIME variables
Document the convention to use variables prefixed by VIRTUAL_RUNTIME.
Add references to the new term where possible.

Another reason is that such variables are recommended
in a warning issued by meta/classes-global/insane.bbclass

(From yocto-docs rev: 11e1ba97edac979868f199e43c1004db6678044c)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Tim Orling <ticotimo@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-03-06 16:54:54 +00:00
Geoff Parker
833506169c ref-manual: variables: adding multiple groups in GROUPADD_PARAM
Add missing documentation on how to add multiple groups with a single
GROUPADD_PARAM:${PN}

(From yocto-docs rev: e55d2aa6a0ee58ee980de2a6ca8d531c7c0cd44a)

Signed-off-by: Geoff Parker <geoffrey.parker@arthrex.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-03-06 16:54:54 +00:00
Johan Bezem
9400b992fd ref-manual: variables: correct sdk installation default path
The SDKPATH variable seems mistakenly identified as the
default path where the SDK will be installed by the generated
installation script, unless option '-d' or a manual input
overrides this default.

The intended variable is SDKPATHINSTALL. SDKPATH indicates
where the SDK is being composed and built.

The definitions have been added/updated.

(From yocto-docs rev: d5b9c4b9c443cc728a11fd1e0a26a11aac8ee2c5)

Signed-off-by: Johan Bezem <jbezem.extern@arri.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-03-06 16:54:54 +00:00
Khem Raj
736ba6823d ref-manual: variables: remove PYTHON_PN
PYTHON_PN is on its way out, therefore it's good to remove it from
documentation so its use is not promoted anymore.

(From yocto-docs rev: 74180c0f6bcdeadbd6f9a69d26f733c716f420fd)

Signed-off-by: Khem Raj <raj.khem@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-02-24 16:13:29 +00:00
Michael Opdenacker
025386d53c manuals: suppress excess use of "following" word
To simplify the style, replace "Following is" and "Following are"
by "here is" and "here are", sounding more natural.

In some cases, also go further by simplifying "Here are/is xxx"
by "xxx are/is" when the "are" or "is" are not two far at
the end of the sentence.

In some cases too, completely remove the sentence, when
it's redundant with the preceding title.

(From yocto-docs rev: 52ba6bb16c73cbc2c0e77496d5226c49bce786f5)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Daniel Ammann <daniel.ammann@bytesatwork.ch>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-02-24 16:13:28 +00:00
Jörg Sommer
b0f2fd0fad documentation: Add UBOOT_BINARY, extend UBOOT_CONFIG
UBOOT_CONFIG accepts a third parameter for the UBOOT_BINARY that isn't
documented. To show its usage another example from the meta-freescale layer
was picked.

(From yocto-docs rev: 8b227582efbe9957026cdce4aef5621661af1fa5)

Signed-off-by: Jörg Sommer <joerg.sommer@navimatix.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-01-12 11:34:06 +00:00
Paul Barker
9723982ecf ref-manual: Fix reference to MIRRORS/PREMIRRORS defaults
After the following meta-yocto commits, MIRRORS & PREMIRRORS are no
longer set in the poky distro config file:

  67b79df4fbff ("poky.conf: remove redundant MIRRORS")
  1b71a3b9418f ("poky: Drop PREMIRRORS entries for scms")

(From yocto-docs rev: bc84dd0b6cdb1b2432ae60c036df9ee15cd53f34)

Signed-off-by: Paul Barker <paul.barker.ct@bp.renesas.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-20 10:59:40 +00:00
Paul Eggleton
7a026c41aa ref-manual: remove semicolons from *PROCESS_COMMAND variables
In nanbield these are no longer needed - spaces are sufficient.
The code still handles any semicolons (replacing them with spaces before
interpreting the value), but let's avoid people adding them from now on
in case we decide to change that in future.

(From yocto-docs rev: 2947f6309f86cdf5322a39d4420e77431a8e3572)

Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:27 +00:00
Paul Eggleton
27949b33b7 ref-manual: update SDK_NAME variable documentation
Update for changes in nanbield. Note that I am documenting what is set
by poky.conf here (since this is Yocto Project documentation), which is
slightly different from what is done in meta/conf/bitbake.conf.

(From yocto-docs rev: 9764cb9e19788eb1caea0d2e95fbe7a5c19887d4)

Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:27 +00:00
Michael Opdenacker
5466a06f17 ref-manual: variables: remove SERIAL_CONSOLES_CHECK
No longer in use in Poky (dropped in Nanbield through
multiple commits)

(From yocto-docs rev: e5d39e85a0db27bfc857fae9649f799179888eee)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:27 +00:00
Michael Opdenacker
f89f69bc04 ref-manual: variables: add RECIPE_MAINTAINER
(From yocto-docs rev: 30e41530402a4f9c37f77e89bae7469b68aad901)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:27 +00:00
Michael Opdenacker
e87f2f8e07 ref-manual: variables: mention new CDN for SSTATE_MIRRORS
(From yocto-docs rev: 4ef0c24b206d71c348ff657a2ab83ab857539fb6)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:27 +00:00
Michael Opdenacker
415ff3a78c ref-manual: document MESON_TARGET
(From yocto-docs rev: 8109eeb5b7a4e5b2f50047e049ce0295bdc94856)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Ross Burton <ross.burton@arm.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-10-30 11:11:17 +00:00
Michael Opdenacker
e0800e8d8a manuals: improve description of CVE_STATUS and CVE_STATUS_GROUPS
- Mention CVE_STATUS_GROUPS in the development manual
  (otherwise only present in the reference manual, but with
  no reference to it)

- In the reference manual description of CVE_STATUS,
  link back to the development manual, to provide context.

(From yocto-docs rev: cfef5fe41b6c819e783c88829448ae38141650a5)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-10-30 11:11:17 +00:00
Michael Opdenacker
9bf8094bda ref-manual: document KERNEL_STRIP
(From yocto-docs rev: 0e1861dcb8819b86aba6a3e024efb8bfe4c300ad)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-10-30 11:11:17 +00:00
Michael Opdenacker
9bc8bfc078 ref-manual: variables: document OEQA_REPRODUCIBLE_TEST_PACKAGE
Introduced by
https://git.yoctoproject.org/poky/commit/?id=88abdec715ed0c1f613c9b5132cd45db741d5c65

(From yocto-docs rev: 2e64352653cd7e89a2b08d84d6f7a1e039d4346a)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-10-30 11:11:17 +00:00
Michael Opdenacker
f32fad635d ref-manual: document KERNEL_LOCALVERSION
Introduced by
https://git.yoctoproject.org/poky/commit/?id=66ed174ccdf7a89cb998f503cc6b631e2d1adcc0

(From yocto-docs rev: 4bdd4976667b802895b13541b77191a65335a175)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Bruce Ashfield <bruce.ashfield@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-10-30 11:11:17 +00:00
BELHADJ SALEM Talel
1b04f4422e ref-manual: variables: add example for SYSROOT_DIRS variable
(From yocto-docs rev: 65b62118da6f355e56c489c6be08ba9ea94b9f04)

Signed-off-by: Talel BELHAJSALEM <bhstalel@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-10-20 14:40:29 +01:00
BELHADJ SALEM Talel
6a70a3366d ref-manual: variables: add TOOLCHAIN_OPTIONS variable
(From yocto-docs rev: 6f7bd97a6d3d6d8cfd149a7e07df35da4141e650)

Signed-off-by: Talel BELHAJSALEM <bhstalel@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-10-20 14:40:29 +01:00
BELHADJ SALEM Talel
ca1e27016d ref-manual: variables: add RECIPE_SYSROOT and RECIPE_SYSROOT_NATIVE
(From yocto-docs rev: 8aa25e2a668d35bab2f79457248abcde92dc92aa)

Signed-off-by: Talel BELHAJSALEM <bhstalel@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-10-20 14:40:29 +01:00
Quentin Schulz
efd54e4d1d ref-manual: variables: provide no-match example for COMPATIBLE_MACHINE
COMPATIBLE_MACHINE is used to forbid the use of a recipe or its packages
for a specific set of machines.

In some cases, it may make more sense to have the logic inverted and
have the recipe always forbidden except for hand-picked machines. Such
could be the case for pieces of software that only support some
architectures. In that scenario, it is sometimes a bit easier on the eye
and for maintenance to use the OVERRIDES mechanism but for that, a
default should be set.

COMPATIBLE_MACHINE:aarch64 = "^(aarch64)$"
COMPATIBLE_MACHINE:mips64 = "^(mips64)$"

wouldn't do much because if COMPATIBLE_MACHINE isn't set, the recipe is
assumed compatible and therefore, if no default is provided we enter
that case.

Hence, we need to add

COMPATIBLE_MACHINE = "^$"

as default so that it only matches the empty string, which isn't
possible for MACHINEOVERRIDES.

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

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>
2023-10-20 14:40:29 +01:00
BELHADJ SALEM Talel
f70a86b27e ref-manual: Fix PACKAGECONFIG term and add an example
PACKAGECONFIG's first and second flag value will be added to PACKAGECONFIG_CONFARGS
and then it will be added to the appropriate variable (EXTRA_OECMAKE, or ...)
So we need to only mention PACKAGECONFIG_CONFARGS and it will lead to other variables.

I added a custom example that can help understanding very well PACKAGECONFIG.

(From yocto-docs rev: 7f26b0c0a08d6be9810128369265b0c494e7191b)

Signed-off-by: Talel BELHAJSALEM <bhstalel@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-10-20 14:40:29 +01:00
Michael Opdenacker
8fd6d222ed manuals: update list of supported machines
The EdgeRouter machine is no longer supported.
https://git.yoctoproject.org/poky/commit/?id=0c64d0e4317e3749f7f7ed9ecd5d08bbb0cedc9e

(From yocto-docs rev: e600522f2d2514bdd888c91043b9c59563ee7a6d)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-10-20 14:40:29 +01:00
Michael Opdenacker
203c78b719 manuals: update linux-yocto append examples
(From yocto-docs rev: 0d195d66e434ddedd33bf8db89643fa5ab192e29)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-10-20 14:40:29 +01:00
Arne Schwerdt
1c90ad84f3 ref-manual: Warn about COMPATIBLE_MACHINE skipping native recipes
(From yocto-docs rev: fcc9b54cc46a0831f79a96e041cbe8deed58cf66)

Signed-off-by: Arne Schwerdt <arne.schwerdt@elbbits.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-10-20 14:40:29 +01:00
Ross Burton
6e7bf979f2 manuals: document LICENSE_FLAGS_DETAILS
(From yocto-docs rev: 299c9b295a8476abdb32fba01ac2f45efacea6f1)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-09-19 15:57:35 +01:00
Michael Opdenacker
16dff2be01 ref-manual: remove AUTHOR variable
Following https://git.openembedded.org/openembedded-core/commit/?id=9d5edd124b7dddb995ceddd79f8a7fc8cf44badf

(From yocto-docs rev: e7da4d122313f369be1c680dadd76ea53ba8dd04)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-08-30 15:54:59 +01:00
Alexander Kanavin
6f361c81ba ref-manual: document image-specific variant of INCOMPATIBLE_LICENSE
This has been around without being properly documented since 2019 (!!!),
and is nowadays the preferred method for enforcing license restrictions,
especially since meta-gplv2 is officially obsolete.

(From yocto-docs rev: efa1c57ecec934998792b7851b4a162be92c8b23)

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>
2023-08-03 15:11:11 +01:00
Andrej Valek
e100e3e0b3 ref-manual: document CVE_STATUS and CVE_CHECK_STATUSMAP
Deprecate CVE_CHECK_IGNORE with CVE_STATUS

(From yocto-docs rev: 8b8054977f31e2d6090521a0102f066b6d563733)

Signed-off-by: Andrej Valek <andrej.valek@siemens.com>
Signed-off-by: Peter Marko <peter.marko@siemens.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-08-03 15:11:11 +01:00
Quentin Schulz
dae1bc6898 docs: fix unnecessary double white space
There's no need for double white spaces here so let's just remove them.

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

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>
2023-06-24 12:23:01 +01:00
Michael Opdenacker
00016cecc4 ref-manual: variables.rst: explicit variables accepting colon separated lists
[YOCTO 15128]

(From yocto-docs rev: af5f4bfd213d2678c0f0463ddff321980d6c9669)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
Reported-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-06-24 12:23:01 +01:00
Mikko Rapeli
71b672b191 variables.rst: document OEQA_REPRODUCIBLE_TEST_TARGET and OEQA_REPRODUCIBLE_TEST_SSTATE_TARGETS
They control which build targets to use when testing build
reproducibility and which build targets can reuse sstate
cache during the test.

(From yocto-docs rev: d2a9f64dd24978a7baf31cf210cdb7f35dd3d15a)

Signed-off-by: Mikko Rapeli <mikko.rapeli@linaro.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-06-16 17:31:06 +01:00
Ed Beroset
ab06a2e244 Add clarification for SRCREV
It was not clear to me what a "full revision identifier" was in the
context of the note documenting SRCREV.  After clarification via IRC,
this submission attempts to clarify what is meant to help future
readers.

(From yocto-docs rev: 484a2d039ffbdde4229cbe20f0ab2c5fc8217d88)

Signed-off-by: Ed Beroset <beroset@ieee.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-06-16 17:31:06 +01:00
Michael Opdenacker
fcaf9c6887 manuals: document SPLASH_IMAGES variable
(From yocto-docs rev: a30204ade74a93077017e3c5e1167102a0213983)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-06-02 16:42:46 +01:00
Michael Opdenacker
9c201d951c ref-manual: document SPLASH variable
(From yocto-docs rev: d32029dd3ce4a66e2fb403a778f748f4a1d52bcc)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-06-02 16:42:46 +01:00
Michael Opdenacker
7475d86c18 ref-manual: improve documentation for kernel-devicetree class
- Document the new KERNEL_DTBDEST and KERNEL_DTBVENDORED variables
- Also document the related KERNEL_DEVICETREE_BUNDLE
  and KERNEL_PACKAGE_NAME variables

(From yocto-docs rev: 19f128e725da35234ec2c234c667ee7ff3d67d8d)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-05-26 17:32:51 +01:00
Michael Opdenacker
e31de097c2 ref-manual: document uboot-sign class and variables
(From yocto-docs rev: 221bcf2e32fb42b6527ff0b4cfe0c4591ab89f78)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Jamin Lin <jamin_lin@aspeedtech.com>
CC: Sean Anderson <sean.anderson@seco.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-05-26 17:32:50 +01:00
Michael Opdenacker
a95cbed77f ref-manual: improve description of kernel-fitimage variables
- Mentioning that they are related to this class
  (for further information about their usage)
- Replace "fitImage" by "FIT image"
- Minor formating and style fixes

(From yocto-docs rev: 07214a4ff2646efb143a02fc9381a029870e9b56)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Jamin Lin <jamin_lin@aspeedtech.com>
Reviewed-by: Sean Anderson <sean.anderson@seco.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-05-26 17:32:50 +01:00
Petr Kubizňák
4417a30196 ref-manual: document devicetree class variables
Document the newly added DT_FILES variable and closely related
DT_FILES_PATH. Also add DT_PADDING_SIZE to the glossary.

(From yocto-docs rev: 8f3f187e2353c718c6fb4e224d13ba559ad2f85b)

Signed-off-by: Petr Kubizňák <kubiznak@2n.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-05-26 17:32:50 +01:00
Michael Opdenacker
ce7a814b3b ref-manual: document FIT_ADDRESS_CELLS
(From yocto-docs rev: 81ee2e82a5bd0b7f1cb910bf266ceb808c05bba9)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Jamin Lin <jamin_lin@aspeedtech.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-05-06 09:38:58 +01:00
Michael Opdenacker
3a89e9a056 ref-manual: variables.rst: don't mention the INIT_MANAGER "none" option
As it is mainly used for internal purposes, so not necessarily useful
for regular users.

OE-core "nodistro" uses it as a fallback to the default setting.

(From yocto-docs rev: aa4d4034707d7c74488678e77d4f45d65782b2a7)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Richard Purdie <richard.purdie@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-05-04 13:53:06 +01:00
Michael Opdenacker
cce6db2a59 ref-manual: variables.rst: document KERNEL_DANGLING_FEATURES_WARN_ONLY
(From yocto-docs rev: dc59b636bb4319a3af552bce84929ddb22a479fb)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Bruce Ashfield <bruce.ashfield@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-04-28 14:46:17 +01:00
Michael Opdenacker
b01a12a135 manuals: expand init manager documentation
- Add details about INIT_MANAGER
  Correct the fact that "none" currently generates
  an image with "sysvinit", at least on Poky.
  This behaviour should probably be changed.

- Expand the "Selecting an Initialization Manager" section.

- Stop mentioning "rescue image" generation, as this
  is not detailed anywhere else.

(From yocto-docs rev: fd99f2753b50b7ad6133b787b90331fcb3a35152)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Paul Eggleton <bluelightning@bluelightning.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-04-28 14:46:17 +01:00
Michael Opdenacker
9b6a25606e manuals: document SPDX_CUSTOM_ANNOTATION_VARS
(From yocto-docs rev: 5811f4eb3e73aa5f8ca90e40ec6559a6d4d58fa3)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Saul Wold <Saul.Wold@windriver.com>
CC: Joshua Watt <JPEWhacker@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-04-28 14:46:17 +01:00
Michael Opdenacker
c48e088682 ref-manual: variables.rst: add wikipedia shortcut for "getty"
(From yocto-docs rev: 2f07fddce909d13a7175e713118af7730e2e5529)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-04-28 14:46:17 +01:00
Paul Eggleton
7508711b38 dev/ref-manual: Document INIT_MANAGER
The INIT_MANAGER variable was added in 3.0 but it seems we didn't get
around to documenting it yet. I have added a variable glossary entry and
made the basic adjustment of the "Using systemd Exclusively" section in
the dev manual, however I think the latter section still needs work.

(From yocto-docs rev: 602c0e8f770516256dab04edfd887377303c06bb)

Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-04-22 10:42:54 +01:00
Paul Eggleton
5a8e2d41a6 ref-manual: move Initramfs entry from variables to terms
It looks like this was accidentally added to the variable glossary
instead of the terms list, so move it to the latter.

(From yocto-docs rev: c9829dcae18cd2cb5f008081d841ca995b76b8bf)

Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-04-22 10:42:54 +01:00
Paul Eggleton
f961d5f73e ref-manual: add SDK_ARCHIVE_TYPE
This appears to have been introduced back in 2019, but we missed
documenting it.

(From yocto-docs rev: 064a5d84890416362a1a7a337347abbe9afe485d)

Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-04-22 10:42:54 +01:00
Paul Eggleton
d469b1fae0 ref-manual: add FIT_CONF_DEFAULT_DTB
New variable in 4.2.

(From yocto-docs rev: 1228ce16a33bd6f00e5399e4c381be808a272281)

Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-04-22 10:42:54 +01:00
Paul Eggleton
356b6f0e32 ref-manual: Remove references to package_tar class
This has been removed in 4.2.

(From yocto-docs rev: a5dcaf95915deec5243ab2fd0711c63e98b2a661)

Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-04-22 10:42:54 +01:00
Paul Eggleton
f901224f88 ref-manual: add BB_CACHEDIR
New in 4.2 (pointer to BitBake manual, changes sent separately for
that).

(From yocto-docs rev: a2112eb3f1084040ad48e392075297b4630b93e1)

Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-04-22 10:42:54 +01:00
Paul Eggleton
62031fbfce dev/ref-manual: Remove references to INC_PR
This technique is no longer used (nor necessary), let's just remove it
to avoid any confusion.

(From yocto-docs rev: 8f50d0bf22fea8064c112f52df06dbd6a85a7a83)

Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-04-22 10:42:53 +01:00
Paul Eggleton
37f0bc3701 ref-manual: update for IMAGE_MACHINE_SUFFIX addition
IMAGE_MACHINE_SUFFIX is a new variable in 4.2, and there were some
associated changes to how IMAGE_NAME, IMAGE_LINK_NAME,
INITRAMFS_IMAGE_NAME and KERNEL_ARTIFACT_NAME are set by default. As a
result, instead of repeating how KERNEL_ARTIFACT_NAME is set by default,
let's just direct people to the entry for that variable so we only have
to update one place.

At the same time I noticed INITRAMFS_IMAGE_NAME  was not documented at
all, so add that in.

(From yocto-docs rev: d53bf2878a268fb71785c73053e3657436f3f5ba)

Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-04-22 10:42:53 +01:00
Paul Eggleton
f64e767e83 ref-manual: Add new RUST_CHANNEL variable
Newly added for 4.2.

(From yocto-docs rev: 89b583413e616aafa5f853a7631cac0f97d387db)

Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-04-22 10:42:53 +01:00
Paul Eggleton
84a9d5e09b ref-manual: add new SDK_ZIP_OPTIONS variable
Newly added for 4.2.

(From yocto-docs rev: e599d82cb3377900632182d216925a2aa44d3989)

Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-04-22 10:42:53 +01:00
Michael Opdenacker
6406677e92 ref-manual: variables: document VOLATILE_TMP_DIR
(From yocto-docs rev: 9e66f080b3609e5d51648feec4d6d7ff72644e9e)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Trevor Woerner <twoerner@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-04-13 11:59:58 +01:00
Michael Opdenacker
bb88c24452 ref-manual: variables.rst: update LAYERSERIES_COMPAT
- Replace by a reference to the description which was
  moved to the BitBake manual.

- Also drop the reference to the Yocto Project Development Tasks Manual
  which doesn't add extra information on this variable.

(From yocto-docs rev: 87cdda981fa6a3d05c559fb00e214214956346dc)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-03-20 13:16:52 +00:00
Michael Opdenacker
8355326ffa manuals: simplify references to the BitBake User Manual
- Replacing
  :ref:`bitbake:bitbake-user-manual/...`
  by :ref:`bitbake-user-manual/...`

  Adding "bitbake:" as a prefix is not necessary
  as there is no naming conflict between the YP
  and the BitBake manuals (all documents are in
  "bitbake-user-manual/")

- Explaining the rules in the README file

- When necessary, fixing line length in the modified paragraphs.

(From yocto-docs rev: d80b31705450cfb98d217ea44ba2edace2d64095)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-03-20 13:16:52 +00:00
Michael Opdenacker
8c49eb57b6 ref-manual: clarify explanations about feature backfilling
(From yocto-docs rev: edae43e60230ad5f2384f0a518b42fc08efc699e)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Joshua Watt <JPEWhacker@gmail.com>
CC: Martin Jansa <martin.jansa@gmail.com>
CC: Tom Hochstein <tom.hochstein@nxp.com>
CC: Richard Purdie <richard.purdie@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-03-20 13:16:52 +00:00
Michael Opdenacker
efc97fe720 manuals: document COMMERCIAL_[AUDIO|VIDEO]_PLUGINS variables
- Add COMMERCIAL_[AUDIO|VIDEO]_PLUGINS variables to the
  variable index.
- Clarify that these plugins are still open-source
- Improve line width

(From yocto-docs rev: 8b161faad6b698b33165f02e1f5e78a693c7817b)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-02-24 15:43:25 +00:00
Fawzi KHABER
22af38b3d9 ref-manual: update DEV_PKG_DEPENDENCY in variables
Since release 4.1, the variable DEV_PKG_DEPENDENCY sets RRECOMMENDS instead
of RDEPENDS for the -dev package on the main package, this change fixes the
documentation to match the actual state

Reviewed-by: Yoann CONGAL <yoann.congal@smile.fr>
(From yocto-docs rev: 0e0790e7bcf4ee2d31301b4351528eb124a1fe98)

Signed-off-by: Fawzi KHABER <fawzi.khaber@smile.fr>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-02-24 15:43:25 +00:00
Michael Opdenacker
dc257d94fc ref-manual: document meson class and variables
(From yocto-docs rev: aacd49e5c72ac1506fc09790902c6047ccf26a02)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-02-24 15:43:25 +00:00
Michael Opdenacker
2b621b21bc ref-manual: classes.rst: improvements to cmake class documentation
- Fix quoting for path to cmake modules
- Document OECMAKE_GENERATOR variable
- Style simplifications

(From yocto-docs rev: ecdc1775e27717ec87442575f65b1f24ca2b0348)

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>
2023-02-24 15:43:25 +00:00
Ulrich Ölmann
197a6f6fbb ref-manual: refer to MACHINE variable instead of KMACHINE
Although in the example case of a "raspberrypi2" the variable KMACHINE has the
same value as MACHINE, only the latter is an allowed override. So do not set the
reader on the wrong track.

Suggested-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
(From yocto-docs rev: 565ebcfe3ed68a9ea036f11cddafb36023f72099)

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-02-24 15:43:24 +00:00
Ulrich Ölmann
eff66f126c kernel-dev,ref-manual: fix old override syntax
Additionally use more common syntax to indicate that an actual machine name is
supposed to be filled in for a concrete use case as has been suggested by Peter
Kjellerstedt (and particularly no KMACHINE). Furthermore add missing quotes in
the reference manual.

Suggested-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
(From yocto-docs rev: b66c035970f860b65cf712285f2d5a023620e6c3)

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-02-24 15:43:24 +00:00
Michael Opdenacker
5b02cfb3e7 manuals: replace unnecessary uses of 'yocto_docs' by internal references
These :yocto_docs: references were making external references
to another section of the manual, using the https://docs.yoctoproject.org
website. It's actually better to use internal references (:doc: for an
entire document, and :ref: for a specific section, as they will cause
an error in Sphinx if one day they are no longer valid.

(From yocto-docs rev: 0beff9dea986a2ea4b496180b29a99490416eeeb)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-02-10 11:03:36 +00:00
Michael Opdenacker
00591a06ce ref-manual: variables.rst: fix broken hyperlink
(From yocto-docs rev: 048db4183ff314e1c6b51be4dc10f0dbc2aa8401)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-02-10 11:03:36 +00:00
Richard Leitner
d792b4f721 ref-manual: variables: FIT_KERNEL_COMP_ALG: add lzo
OE-Core rev f1257d61b76d027d4ece734439993b6bf4e48907 introduced support
for using lzo as compression algorithm for fitImage contained kernel
images.
This patch adds the corresponding documentation to FIT_KERNEL_COMP_ALG
and FIT_KERNEL_COMP_ALG_EXTENSION.

(From yocto-docs rev: aba0ab326ea72ff10492e73b452b51d1beaa50d6)

Signed-off-by: Richard Leitner <dev@g0hl1n.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-02-10 11:03:36 +00:00
Luca Ceresoli
bfd8573b6e manuals: fix typo in the MLPREFIX description
(From yocto-docs rev: 71535ccea091f130e94339072e3c579661dbf3d8)

Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-01-25 15:12:48 +00:00
Michael Opdenacker
ce7b98d363 ref-manual: initial documentation for go and go-mod classes
This addresses [YOCTO #14582]

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-01-25 15:12:48 +00:00
Michael Opdenacker
8b1909aa6f manuals: simplify references to classes
Now that .bbclass is removed from class section titles.
We can now have, for example, :ref:`ref-classes-insane`
instead of :ref:`insane <ref-classes-insane>`.

Then, when necessary, rework paragraphs so that they
have lines of even length, not exceeding 80 characters.

(From yocto-docs rev: e76190e3be78c1e483bec0469f1e437dbf8f3791)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Suggested-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-01-06 17:39:09 +00:00
Michael Opdenacker
c1c672e7fa manuals: final removal of SERIAL_CONSOLE variable
This deprecated variable has been removed for good through
https://git.openembedded.org/openembedded-core/commit/?id=9d053af1fb570b4e3483de4ecd6827e1e0be61b7

(From yocto-docs rev: db22748d8a2bc4c53c6415537c772d2c49220aec)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-18 10:41:21 +00:00
Michael Opdenacker
6846d4d00b manuals: define proper numbered lists
Using "#." instead of "1.", "2.", "3.", etc.

(From yocto-docs rev: 11c2585acd0fa6c330702af2359ce5a9e47cde1f)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-18 10:41:21 +00:00
Michael Opdenacker
766a44b8e3 manual: improve documentation about using external toolchains
- Remove the redundant FAQ entry about this topic,
  already covered in a specific section of the Development Tasks manual

- Document the TOOLCHAIN_LOCATION variable

- Expand both the Development Tasks manual and
  the TCMODE variable description using details from the FAQ entry.

- Mention the "meta-arm-toolchain" layer too.

(From yocto-docs rev: 53faa54a8e6311b4d3d41d96cb1a497d0f6502fb)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-18 10:41:21 +00:00
Michael Opdenacker
397586e4ae ref-manual: update references to release notes
Now part of the Yocto Project manual.

(From yocto-docs rev: fe23084f746f0959afbf7d4a49e00299e39fba09)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-18 10:41:21 +00:00
Michael Opdenacker
01e5d22507 manuals: fix double colons
Fixing double colons appearing alone on a line, while
they could be put at the end of the previous line.

Sometimes placing a note after the quoted text
to avoid such a situation. It's more natural too
not to have a note between the introduction text
and the quoted section.

(From yocto-docs rev: fb054622f5119444eb947fe580253f37e0d872c6)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-18 10:41:21 +00:00
Michael Opdenacker
f417d3274c manuals: add missing references to variables
[YOCTO #14508]
(From yocto-docs rev: 7878a21be8fb6c7a1ab88ae44aa5f7bf0079391a)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-18 10:41:21 +00:00
Michael Opdenacker
f731bf972d ref-manual: add references to variables only documented in the BitBake manual
This makes the Yocto Project manual variable list and index more useful,
not missing any potentially useful variable.

The price to pay is that a reference to such variables now has to go through
the intermediate reference in the Yocto Project variable list, instead
of going straight to the Bitbake manual.

(From yocto-docs rev: 3d308812cd9aa906890a0f8562fc28c1cd8aaab6)

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-12-18 10:41:21 +00:00
Michael Opdenacker
945c669138 manuals: split dev-manual/common-tasks.rst
A 500 KB source file is always harder to manage,
and can have section title conflicts.

So, the "Common Tasks" document is gone and all
its constituents are moved up one level.
You now have 40 chapters in the Development Tasks Manual.

(From yocto-docs rev: 8a45bc469411410020b8e688c137395fcaf3761b)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-01 19:20:29 +00:00
Michael Opdenacker
4d01625794 manuals: fix paragraphs with the "inherit" word
Nothing wrong with this word, but instances of "inherit"
were looked for while looking for class names without references.
Fixing alignment and sometimes syntax.

(From yocto-docs rev: c418c645a360e74ebb91765a3041336f03097e0d)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-01 19:20:29 +00:00
Michael Opdenacker
55621c31f1 manuals: add missing references to classes
Sometimes fixing line length in modified paragraphs too.

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

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-01 19:20:29 +00:00
Michael Opdenacker
51b6a55a80 ref-manual/variables.rst: expand PARALLEL_MAKE description
Explain that this variable apply not only to make, but also
to ninja, and to other build tools which support parallel jobs.

(From yocto-docs rev: d3fe2aba3948040a01b9068df5085453ad65309c)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-11-10 22:12:56 +00:00
Michael Opdenacker
15a8edcead ref-manual/variables.rst: expand BB_NUMBER_THREADS description
Explain that reducing its value to reduce system load
is not sufficient if PARALLEL_MAKE is not reduced as well.

(From yocto-docs rev: f4986faa5576ec1c146e606220421a686c4a9b57)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-11-10 22:12:56 +00:00
Michael Opdenacker
3a7dd1d368 manuals: add shortcut for Wikipedia links
(From yocto-docs rev: 47101c15cce156ab71683cac1c42ab94f43bdbee)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-11-07 21:31:32 +00:00
Michael Opdenacker
1d2681fa72 manuals: document "mime-xdg" class and MIME_XDG_PACKAGES
(From yocto-docs rev: dabd2e95cf8ba8ed620bfd135deb6cfcf5d74b16)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-11-07 21:31:32 +00:00
Michael Opdenacker
a6f7c43e92 ref-manual: variables.rst: document spdx-create class variables
(From yocto-docs rev: fd9ee9e1701a90c19d4957ec387e0ad17757aa06)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-11-07 21:31:32 +00:00
Michael Opdenacker
b44fbe5b1b manuals: use references to the "Build Directory" term
Replace instances of "Build Directory" and "build directory"
(when applicable) by :term:`Build Directory` as already
done in most places.

Doing this, fix the indentation of the paragraphs with
this term.

(From yocto-docs rev: dce50679242d39f133e0cde5c8483b5e69f3eb54)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-28 15:48:03 +01:00
Michael Opdenacker
6f4ccc4dad manuals: stop referring to the meta-openembedded repo from GitHub
(From yocto-docs rev: de6e7c05fbcff99a6f1fe2a2bf889b559b9b576b)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-28 15:48:03 +01:00
Michael Opdenacker
4def515eeb manuals: replace "_" by "__" in external links
(From yocto-docs rev: 25142cd8121fdd6a8e0524fc8417fc666c498981)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-28 15:48:03 +01:00
Mikko Rapeli
8a9ac57515 ref-manual: variables.rst: add documentation for CVE_VERSION
Related to cve-check.bbclass.

(From yocto-docs rev: 1218775a9b32ac16556645c5d186007c19a5baf4)

Signed-off-by: Mikko Rapeli <mikko.rapeli@linaro.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-28 15:48:03 +01:00
Paul Eggleton
ae9eb5684a ref-manual: add OVERLAYFS_QA_SKIP
New variable in 4.1.

(From yocto-docs rev: 105a44efe290ac36a370a4946aadc2e046a86e64)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-19 17:32:57 +01:00
Paul Eggleton
01372ac01c ref-manual: add overlayfs class variables
The overlayfs class was added in the honister release.

(From yocto-docs rev: cff6b5a167d8f7d99a351c7989bc86af5e553552)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-19 17:32:57 +01:00
Paul Eggleton
7a417c450e ref-manual: add WIRELESS_DAEMON
Not new in 4.1, but the syntax and usage in packagegroup-base is.

(From yocto-docs rev: 01f8393989528ed655fd20338c8764ac12bba010)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-19 17:32:57 +01:00
Paul Eggleton
0aa40dc125 ref-manual: add OVERLAYFS_ETC_EXPOSE_LOWER
New variable in 4.1.

(From yocto-docs rev: a410d4b7a5cd38badc318508f003e3151846776e)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-19 17:32:57 +01:00
Paul Eggleton
d73883dfef ref-manual: add previous overlayfs-etc variables
These were supported in releases prior to 4.1.

(From yocto-docs rev: 86f367fc9946904b5056fb86fb2cc339a0f96b0a)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-19 17:32:57 +01:00
Paul Eggleton
1bdb6457dd ref-manual: complementary package installation recommends
Add a note to the COMPLEMENTARY_GLOB variable glossary entry mentioning
that recommends aren't installed (since this seems to be the only place
that complementary package installation is really discussed). Also turn
the paragraph about globbing into a regular paragraph as I don't think
it should be called out in a note block.

(From yocto-docs rev: abc67b101b0821b174eb65bc13922a8bee1016eb)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-19 17:32:57 +01:00
Paul Eggleton
b1d1777865 Update documentation for classes split
* Make reference to meta/classes* instead of just meta/classes
* Update each reference to the path where the class has moved
* Add a brief explanation to the classes reference explaining the split
* Add a note to INHERIT, INHERIT_DISTRO, IMAGE_CLASSES and USER_CLASSES
  variable glossary entries mentioning where the specified classes must
  be located. I contemplated adding the same note to PACKAGE_CLASSES
  but decided against it, as it has a very specific usage and such a
  note might distract from the narrative of that entry.
* Also trim the IMAGE_CLASSES entry which was quite outdated.
* INHERIT += no longer works with testimage so drop the note about that

(From yocto-docs rev: e76bed00b452d3049f6c22afbfb980b557a141bd)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-19 17:32:57 +01:00
Paul Eggleton
c29eb10e31 ref-manual: remove reference to testimage-auto class
testimage-auto was removed in the thud release.

(From yocto-docs rev: 618351169c09470280aeee53a63aba88788efc4b)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-19 17:32:57 +01:00
Paul Eggleton
335a230a35 ref-manual: add MOUNT_BASE variable
New variable for 4.1.

(From yocto-docs rev: 91c6c3dcb36e52e276f000b0e60aba02d546e994)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-19 17:32:57 +01:00
Paul Eggleton
a9a00a6004 ref-manual: add KERNEL_DEPLOY_DEPEND
New variable in 4.1.

(From yocto-docs rev: efd1a6f5d13a031c0c093bbcfb4bcf935e37ed25)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-19 17:32:57 +01:00