Commit Graph

2354 Commits

Author SHA1 Message Date
Michael Opdenacker
832975f59d manuals: use "manual page(s)"
Instead of "manpage(s)" or "man page(s)".
To address one of the errors reported by "make stylecheck"

(From yocto-docs rev: f6e69f8877d1d33200993f21b448e7fa3cf7859b)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-04-05 07:23:59 -07:00
Michael Opdenacker
b6f6c72945 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: db88c2021062c95fe49b54351952753390d45a6a)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Tim Orling <ticotimo@gmail.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-03-25 04:11:26 -10:00
Michael Opdenacker
5b75b5cbcf 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: a0d93ea1ddfdfbcde8dac3aa328307be778f9e3c)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-03-25 04:11:26 -10:00
Geoff Parker
d51c7e990b 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: 46f82dcb3b4042491efd44b9c15a06e3c910ec85)

Signed-off-by: Geoff Parker <geoffrey.parker@arthrex.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-03-25 04:11:26 -10:00
Johan Bezem
48bd3888df 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: f7ce2abbdcff625356b337137e91f642ff6a4dc2)

Signed-off-by: Johan Bezem <jbezem.extern@arri.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-03-25 04:11:26 -10:00
Luca Ceresoli
0b59f7efc6 ref-manual: tasks: do_cleansstate: recommend using '-f' instead for a shared sstate
do_cleansstat can produce build errors when using a shared sstate cache.

Add a note to clearly discourage, provide a safe alternative (bitbake -f),
and the rationale.

Suggested-by: Quentin Schulz  <quentin.schulz@theobroma-systems.com>
Link: https://lore.kernel.org/yocto-docs/20240219155513.76738-1-luca.ceresoli@bootlin.com/T/#m5529687ecb0f9ec2dacddcb6ff58e2df73af9cde
(From yocto-docs rev: 3fb8b5ad7edfa186744396deb7111ba3e31a857b)

Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
Reviewed-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-03-25 04:11:26 -10:00
Luca Ceresoli
59b33ce497 ref-manual: tasks: do_cleanall: recommend using '-f' instead
do_cleanall can produce failures when used in legitimate cases, such as
with recipe variants (foo and foo-native) or a shared DL_DIR. This is why
it is forbidden when writing tests that will run on the autobuilders
(https://docs.yoctoproject.org/test-manual/intro.html?highlight=cleanall#considerations-when-writing-tests).

Reword the documentation to clearly discourage, provide a safe alternative
(bitbake -f -c fetch), and the rationale with an example.

Reported-by: Sam Liddicott
Link: https://bootlin.com/blog/yocto-sharing-the-sstate-cache-and-download-directories/#comment-2650335
(From yocto-docs rev: 92e1d1fba336de12637b75b043b86485b80324a2)

Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
Reviewed-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-03-25 04:11:26 -10:00
Michael Opdenacker
0a4530c3ed ref-manual: system-requirements: remove outdated note
To align this document with the version in the master branch

(From yocto-docs rev: 08ce7db2aa3a38deb8f5aa59bafc78542986babb)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-03-01 05:19:55 -10:00
Michael Opdenacker
05da4fad79 ref-manual: system-requirements.rst: fix AlmaLinux variable name
(From yocto-docs rev: fb0fa6e06df46be6b4e35e5a83252277abcd64d7)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-03-01 05:19:55 -10:00
Michael Opdenacker
63f7d6897f ref-manual: system-requirements: update packages to build docs
- "git" is now required to run "set_versions.py"

- Fix Ubuntu / Debian packages.
  The previous instructions didn't run on Debian 12
  Tested on Ubuntu 22.04 and Debian 12.

  Reported on https://lists.yoctoproject.org/g/docs/message/4789

(From yocto-docs rev: f2a4799fa1cb6ea406d97e1b47ce888e7f5dd264)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: <mhagans@skyviewsat.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-03-01 05:19:55 -10:00
Michael Opdenacker
f51a5fd78d ref-manual: system-requirements.rst: simplify supported distro requirements
- This allows to continue sharing the updated Ubuntu/Debian requirements
  with the brief-yoctoprojectqs/index.rst without indentation mismatches
  (caused by using the same macro in two different contexts: in direct
  text and in a bullet list).

- Update poky.yaml.in to adapt the number of spaces at the beginning
  of lines.

- brief-yoctoprojectqs/index.rst: fix bad number of spaces
  before quote block.

(From yocto-docs rev: 488731c09bf63fadc02ddcdd94fb3374dafce528)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-03-01 05:19:55 -10:00
Michael Opdenacker
54321fcec4 manuals: updates for building on Windows (WSL 2)
- Use the Wikipedia naming scheme: WSL 2 instead of WSLv2
- Take into account Windows Server 2019 and 2022 which are
  supported too.
- Improve some explanations

(From yocto-docs rev: e64c1154c358128d76b1b8e3a5809dbaa8dc6881)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-03-01 05:19:55 -10:00
Michael Opdenacker
2fb92fb14f ref-manual/system-requirements.rst: recommend buildtools for not supported distros
Also minor correction to supported distribution notes

(From yocto-docs rev: cb417cef74b87b53300eb05c21675b5e24a10ca7)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Suggested-by: Alexander Kanavin <alex.kanavin@gmail.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-03-01 05:19:55 -10:00
Michael Opdenacker
e5620de355 ref-manual: system-requirements: modify anchor
To align with the "master" branch

(From yocto-docs rev: aaeb061fa8ff73496175eba59f53a19fdcf08f64)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-03-01 05:19:55 -10:00
Michael Opdenacker
e0c348b644 manuals: update references to buildtools
Also fix number of corresponding paragraphs

(From yocto-docs rev: 28ee2d91fe4dd0549940dc5df1ff1d59363fcc0f)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-03-01 05:19:55 -10:00
Paul Eggleton
9e5a9e6f94 ref-manual: add info on buildtools-make-tarball
PENDING ON THIS OE-CORE PATCH:
install-buildtools: support buildtools-make-tarball and update to 4.1
https://lists.openembedded.org/g/openembedded-core/message/171522

Cover the use case and the new provided tarball.

(From yocto-docs rev: 824c075c31650b9b466ac54fdf926043927b7045)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-03-01 05:19:55 -10:00
Michael Opdenacker
7b6b03a1eb manuals: add minimum RAM requirements
Measured by generating a "core-image-sato" image for a "qemux86-64"
machine from an Ubuntu 22.04 VM with 4 cores.

Less memory was not enough and caused Out of Memory failures.

(From yocto-docs rev: 5009d3898a1649074d1fc252ed33ecbf3235ed75)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-03-01 05:19:55 -10:00
Michael Opdenacker
64778b45ca manuals: update disk space requirements
Tests made on Poky master on March 16, 2023.

Add a "Free Disk Space" section to the "System Requirements" document.

(From yocto-docs rev: 6e88a53c47f15376c4eec8b34d14239dcf285da3)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-03-01 05:19:55 -10:00
Michael Opdenacker
fa870dfd0f 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: 2539f1b9cbf9bdd40eff93c6522dc76133debed7)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Daniel Ammann <daniel.ammann@bytesatwork.ch>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-03-01 05:19:54 -10:00
Michael Opdenacker
74ebddb921 ref-manual: release-process: grammar fix
(From yocto-docs rev: d1b3e26893f258b1633f8a90cf61456b54c47433)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-03-01 05:19:54 -10:00
Jörg Sommer
f634b9852e 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: aba67b58711019a6ba439b2b77337f813ed799ac)

Signed-off-by: Jörg Sommer <joerg.sommer@navimatix.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-01-24 04:04:56 -10:00
Enguerrand de Ribaucourt
78e79d47c2 manuals: document VSCode extension
The VSCode extension is now officially maintained and published by the
Yocto Project so it should be referenced in the manuals to help users
discover it.

I located the most relevant places to reference the extension by looking
at how the old Eclipse plugin was documented in the 2.6 manuals as well
as the current Toaster references.

(From yocto-docs rev: 21ec0d3b52069dfc85ff47fb4f913a26a092c480)

Signed-off-by: Enguerrand de Ribaucourt <enguerrand.de-ribaucourt@savoirfairelinux.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-01-24 04:04:56 -10:00
Michael Opdenacker
f5f650aaa4 ref-manual: resources: sync with master branch
(From yocto-docs rev: 0c3596248cee47079a4c99ed6b476cee36cc84de)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-01-24 04:04:56 -10:00
Maxin B. John
d1a5c51431 ref-manual: classes: remove insserv bbclass
insserv.bbclass was removed from oe-core:

commit e6bb5dbb62
Author: Richard Purdie <richard.purdie@linuxfoundation.org>
Date:   Sun May 10 12:30:49 2015 +0100

insserv: Remove

(From yocto-docs rev: eddb6c4e36e298218c23bf688cb1c9c06f32b0d6)

Signed-off-by: Maxin John <maxin.john@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-01-24 04:04:56 -10:00
Michael Opdenacker
d9532264b9 ref-manual: update tested and supported distros
According to currently active workers
https://autobuilder.yoctoproject.org/typhoon/#/workers
and to the "workers_prev_releases" definition
in https://git.yoctoproject.org/yocto-autobuilder2/tree/config.py

Also correct the text saying that SANITY_TESTED_DISTROS
lists currently tested distros.

Also replace AlmaLinux 8.8 and 9.2 by just AlmaLinux 8 and 9,
as we update our workers anyway.

(From yocto-docs rev: 79a6ec6847cdfc40d75def36993a40fec853a7a1)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-01-10 05:14:16 -10:00
Aatir Manzur
064936af55 docs: add CONVERSION_CMD definition
(From yocto-docs rev: ba1458b04e2828e728c2815b1221e9399132d25d)

Signed-off-by: Aatir Manzur <aatrapps@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-12-21 06:14:00 -10:00
Michael Opdenacker
15b42171a3 ref-manual: releases.svg: update nanbield release status
- nanbield is now released
- update the start and end dates

(From yocto-docs rev: 51f26829e89674c55471a6a077e5f49a97db84c3)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-12-21 06:14:00 -10:00
Paul Barker
cd6f183a34 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: c7882126a75e8814764379d40bf56f39da5d3c19)

Signed-off-by: Paul Barker <paul.barker.ct@bp.renesas.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-12-21 06:14:00 -10:00
Michael Opdenacker
a2d67684cc manuals: update class references
Synchronizing with master whenever possible,
to make the branch easier to maintain.

(From yocto-docs rev: 825b1292ab08770b2d8cfdc1e11358a2790c1a1b)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-11-28 05:00:32 -10:00
Michael Opdenacker
fdd88b549f ref-manual: classes: explain cml1 class name
(From yocto-docs rev: aa2f61675e79e04207e91ab845892d581069fb74)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Martin Jansa <martin.jansa@gmail.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-11-28 05:00:32 -10:00
Paul Eggleton
95795dff9b 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: 4273dc298aba67fe07f19b52e5f8fa1d183d054c)

Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-11-28 05:00:32 -10:00
Michael Opdenacker
942c66a9fb ref-manual: variables: add RECIPE_MAINTAINER
(From yocto-docs rev: 97661c8583e3be2ee992d2c0a158554086f6d038)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-11-28 05:00:32 -10:00
Michael Opdenacker
12643571ec ref-manual: variables: mention new CDN for SSTATE_MIRRORS
(From yocto-docs rev: 57cf137a45070d45d4ae2518d6c45e226166bbee)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-11-28 05:00:32 -10:00
Michael Opdenacker
9536f32528 ref-manual: variables: document OEQA_REPRODUCIBLE_* variables
(From yocto-docs rev: 40285a94db71dabfbddc324ee71b46984dbdb6fd)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-11-28 05:00:32 -10:00
BELHADJ SALEM Talel
59077aa77b ref-manual: variables: add example for SYSROOT_DIRS variable
(From yocto-docs rev: 63fcc08bbb053262c3292c884ac91f389f1d9d97)

Signed-off-by: Talel BELHAJSALEM <bhstalel@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-10-25 04:45:51 -10:00
BELHADJ SALEM Talel
bdea205855 ref-manual: variables: add TOOLCHAIN_OPTIONS variable
(From yocto-docs rev: d7397a985fa085b4ca97aaebedfec5fcaf4e82de)

Signed-off-by: Talel BELHAJSALEM <bhstalel@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-10-25 04:45:51 -10:00
BELHADJ SALEM Talel
bf5e50a353 ref-manual: variables: add RECIPE_SYSROOT and RECIPE_SYSROOT_NATIVE
(From yocto-docs rev: e4c3fd543cb1b98255dcd3b40819ebcc7ef3a52a)

Signed-off-by: Talel BELHAJSALEM <bhstalel@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-10-25 04:45:51 -10:00
Quentin Schulz
955796ad7e 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: d66b53eebe5b2320ce12926b309e48c9e32523f3)

Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-10-25 04:45:51 -10:00
BELHADJ SALEM Talel
0f23056836 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: 94eb37ef56cbb19b5b6e28bef522a7288a1a61f9)

Signed-off-by: Talel BELHAJSALEM <bhstalel@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-10-25 04:45:51 -10:00
Paul Eggleton
6fd2902f05 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: a84adfaeda5a790275d020fc77d721e8560a5728)

Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-10-25 04:45:51 -10:00
Michael Opdenacker
aaf748b95f manuals: update linux-yocto append examples
(From yocto-docs rev: b5d385f20d22566e12a7938a9894b86429f1dcfb)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-10-25 04:45:51 -10:00
Arne Schwerdt
811cf0320c ref-manual: Warn about COMPATIBLE_MACHINE skipping native recipes
(From yocto-docs rev: 48e5fb383570dc6a067b14cc621e4cb347db900c)

Signed-off-by: Arne Schwerdt <arne.schwerdt@elbbits.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-10-25 04:45:51 -10:00
Michael Opdenacker
7b43af7ad4 ref-manual: releases.svg: Scarthgap is now version 5.0
According to https://wiki.yoctoproject.org/wiki/Releases

(From yocto-docs rev: 1ce820adce0d9ca4eb6457dc089d55a0cec8c266)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-10-18 05:13:24 -10:00
Michael Opdenacker
3fde5d606b manuals: document "mime-xdg" class and MIME_XDG_PACKAGES
(From yocto-docs rev: 4415d95358497b23f0a7b10f9ee31203ccc01eff)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-09-23 05:26:16 -10:00
Michael Opdenacker
870c6a73a7 ref-manual: qa-checks: align with master
(From yocto-docs rev: 56bbfab163a6b42aaa32d9350f30b2414a60fc75)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-09-23 05:26:16 -10:00
Michael Opdenacker
b099a1c252 manuals: update former references to dev-manual/common-tasks
(From yocto-docs rev: f8bb4c392912f15bb78f6f25910f85897abb4e3d)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-09-23 05:26:16 -10:00
Michael Opdenacker
90e943b8d1 ref-manual: add new variables
Backported from "master" and used in dev-manual
documents to be synchronized with master.

(From yocto-docs rev: 1938d6017a1c9acc2c5f57c4cc6a87b918609381)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-09-23 05:26:16 -10:00
Michael Opdenacker
2be874d5b4 ref-manual: add Initramfs term
Backported from the master branch

(From yocto-docs rev: f5ecf1f407585617d258b6afc706d43fdbb33547)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-09-23 05:26:16 -10:00
Michael Opdenacker
5ea10fc05b ref-manual: add meson class and variables
Backported from the master branch

(From yocto-docs rev: 266540ffdf84df14ebde374927e6e8ddd8ee688e)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-09-23 05:26:16 -10:00
Michael Opdenacker
5d822b3131 manuals: add new contributor guide
(From yocto-docs rev: 028a1b89fbb6ee7f02a7ca8cd481931e096d764b)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-09-08 16:09:42 -10:00
Michael Opdenacker
be72b71280 ref-manual: system-requirements: update supported distros
- Update according to changes in SANITY_TESTED_DISTROS
  (meta-poky/conf/distro/poky.conf)

- No longer declare as "Supported" the distributions versions
  which are End of Life for their vendors, as some of them
  (Ubuntu for example) ship updates to subscribers only,
  which the Yocto Project has no access to.

- List distribution versions which were previously tested
  for the branch of the Yocto Project being considered.

(From yocto-docs rev: 84d7f2e2a218502b4af4fc2e7de1761e489f86f4)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-09-08 16:09:42 -10:00
Michael Opdenacker
fa7dd8ac75 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: 4dfef81ac6164764c6541e39a9fef81d49227096)

Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-08-02 04:47:13 -10:00
Michael Opdenacker
cc3287637c ref-manual: release-process: update for LTS releases
(From yocto-docs rev: 145488ac9ee4ad5efb0966f07ff5e7ff804f6562)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-07-21 06:27:34 -10:00
Michael Opdenacker
23ca3ba890 ref-manual: add LTS and Mixin terms
(From yocto-docs rev: f9ce60e2a035f3921901d2c6633df6e302cad1c7)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-07-21 06:27:34 -10:00
Quentin Schulz
6c185e7ae0 docs: ref-manual: terms: fix typos in SPDX term
Fixes: 2c53ac40e99a ("ref-manual: terms.rst: add SBOM and SPDX terms")
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: aaa554381a46c66d7708967c65893992760aa5fe)

Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-07-21 06:27:34 -10:00
Ed Beroset
17760d65dd ref-manual: 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: c570732cededffa2992173e6c43de4845a1d7d44)

Signed-off-by: Ed Beroset <beroset@ieee.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-06-21 04:00:58 -10:00
Steve Sakoman
511507f0ce system-requirements.rst: add Fedora 36 and AlmaLinux 8.7 to list of supported distros
(From yocto-docs rev: 0a1257860ed41d526856dc71b36e7f96155c0844)

Signed-off-by: Steve Sakoman <steve@sakoman.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-02-23 08:17:02 +00:00
Michael Opdenacker
1b1ca97a25 ref-manual: document SSTATE_EXCLUDEDEPS_SYSROOT
Backport from master:
https://git.yoctoproject.org/yocto-docs/commit/?id=b6690011c14ce4bf30571f045152a9d324ad5039

(From yocto-docs rev: 0b0509d14742ad1cd050a79164718e6e17020c65)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-02-15 10:26:49 +00:00
Michael Opdenacker
d3e3783973 manuals: document SPDX_PRETTY variable
Now that it has been backported to Kirkstone
https://git.yoctoproject.org/poky/commit/?h=kirkstone&id=99483cff5c358d847ceb077349321eb57d5143e4

(From yocto-docs rev: 5883e897c34f25401b358a597fb6e18d80f7f90b)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-01-10 14:21:45 +00:00
Michael Opdenacker
c883909950 SPDX and CVE documentation updates
Backporting from master the ones that are applicable to kirkstone.

(From yocto-docs rev: c10d65ef3bbdf4fe3abc03e3aef3d4ca8c2ad87f)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Mikko Rapeli <mikko.rapeli@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-07 15:04:15 +00:00
Steve Sakoman
32ca0ff8fa system-requirements.rst: Add Ubuntu 22.04 to list of supported distros
(From yocto-docs rev: f632dad24c39778f948014029e74db3c871d9d21)

Signed-off-by: Steve Sakoman <steve@sakoman.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-09-16 17:55:51 +01:00
Jon Mason
b051dc5d4f 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: 7794a3449e1b92a57a551395a65e7083eefff227)

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:41 +01:00
Michael Opdenacker
236f30b8a9 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.

Initially contributed to the master branch by Quentin Schulz.

(From yocto-docs rev: d9b3dcf65ef25c06f552482aba460dd16862bf96)

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-07-20 15:52:51 +01:00
Quentin Schulz
8c7145a12d 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:22:12 +01:00
Paul Eggleton
5cad452c85 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:22:12 +01:00
Richard Purdie
47fab8caa8 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:22:12 +01:00
Paul Eggleton
445d91575d 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:22:12 +01:00
Paul Eggleton
9e75211b3a 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:22:12 +01:00
Paul Eggleton
b3f040b4a5 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:22:12 +01:00
Paul Eggleton
8da3055567 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:22:12 +01:00
Paul Eggleton
ad8d1e6228 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:22:12 +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