Commit Graph

6162 Commits

Author SHA1 Message Date
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
Lee Chee Yang
cd8e085ad3 migration-guides: add release notes for 4.0.12
(From yocto-docs rev: d43d4314df65b7e7c6d6b79c777d11c5a7135c43)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Reviewed-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
de29a6932e dev-manual: wic.rst: Update native tools build command
Requirements list seems to be outdated. It is not possible to follow
instructions for Raw Mode as not all of the native tools are available.
All wic dependencies are gathered under wic-tools package. Some commands
in the instruction already use wic-tools native sysroot, but this
dependency is not specified in the requirements.
Update the command for building native tools to use wic-tools instead
of the seperate packages.

(From yocto-docs rev: 7c03bcb3031c89b5183e5b4f3f0703bc91a014e2)

Signed-off-by: Daniel Semkowicz <dse@thaumatec.com>
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-08-19 05:56:59 -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
Lee Chee Yang
b54543f7e8 migration-guides: add release notes for 4.0.11
(From yocto-docs rev: 96575a0c06d206400a5efde2ec2ddcda54a43105)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.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
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
Hannu Lounento
ab6c16cb55 profile-manual: fix blktrace remote usage instructions
The references to the target and host systems (i.e. the client and
server respectively) were swapped in the instructions.

Also, there's no need to specify the device node on the server command
line that is run on the host system.

The previous, incorrect, instructions resulted typically in:

    target# blktrace -l /dev/mmcblk1
    server: waiting for connections...

and

    host$ blktrace -d /dev/mmcblk2 -h target
    Invalid path /dev/mmcblk2 specified: 2/No such file or directory

unless the same device node happened to exist on the host system.

Based on

    target# blktrace --version
    blktrace version 2.0.0

and

    host$ blktrace --version
    blktrace version 2.0.0

(From yocto-docs rev: 6d16d2bde0aa32276a035ee49703e6eea7c7b29a)

Signed-off-by: Hannu Lounento <hannu.lounento@vaisala.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-06-21 04:00:58 -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
Daniel Ammann
2afcf3e39f overview-manual: concepts.rst: Fix a typo
(From yocto-docs rev: 8241867b565310341e4741a5f0a7597d5c5c84ab)

Signed-off-by: Daniel Ammann <daniel.ammann@bytesatwork.ch>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-05-30 04:11:16 -10:00
Lee Chee Yang
17955962d7 migration-guides: add release notes for 4.0.10
(From yocto-docs rev: ca90cec1c441deae4289060d521f86c0c68a5e50)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-05-30 04:11:16 -10:00
Michael Opdenacker
1184ea6f5e migration-guides: use new cve_mitre macro
(From yocto-docs rev: 1b9b0bea93fa3793d8807f04d1588cd568e2ffe3)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-05-30 04:11:16 -10:00
Michael Opdenacker
7350eae0c4 conf.py: add macro for Mitre CVE links
New cve_mitre macro for CVEs that are not found (yet) on https://nvd.nist.gov/

(From yocto-docs rev: ff675ce150187561d6d1e8b8ff0eeb10b2696ec6)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-05-30 04:11:16 -10:00
Quentin Schulz
075e7e6d8c Revert "docs: conf.py: fix cve extlinks caption for sphinx <4.0"
This reverts commit c9922076f5c1285d9cfd6aff8ce5b6635d88222f.

Since the minimum version required to build the docs has been bumped in
the previous commit to 4.0, this commit is not required. Moreover, since
Sphinx 5.0 triggers a warning when extlinks captions are not using %s
substitution and Sphinx 6.0 will fail to build without the substitution
characters, this revert is now required to be able to build the docs.

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

Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-05-30 04:11:16 -10:00
Lee Chee Yang
4cc0e9438b migration-guides: add release-notes for 4.0.9
(From yocto-docs rev: 8388be749806bd0bf4fccf1005dae8f643aa4ef4)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-04-26 04:03:21 -10:00
Michael Opdenacker
2a15bb1af3 migration-guides: add 4.0.8 release notes
(From yocto-docs rev: 86d0b38a97941ad52b1af220c7b801a399d50e93)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-03-20 12:53:45 +00:00
Michael Opdenacker
f85edc197e dev-manual: common-tasks.rst: add link to FOSDEM 2023 video
(From yocto-docs rev: 16ecbe028f2b9cc021267817a5413054e070b563)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Joshua Watt <JPEWhacker@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-02-23 12:18:34 +00: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
fc5364a032 manuals: update patchwork instance URL
https://patchwork.openembedded.org/ has been since long discontinued
Also better to mention https://patchwork.yoctoproject.org/
than the patchwork home page.

(From yocto-docs rev: e7dcd04a1a4f6db42e7469226623016dccd2186d)

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
e4e0dabc0d bsp-guide: fix broken git URLs and missing word
(From yocto-docs rev: 115793b87f922fe18b8e791f6cc09308a002eb29)

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
fd03545975 profile-manual: update WireShark hyperlinks
(From yocto-docs rev: c8de3cd057f3a72e8467a927edc5bd82183860f7)

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
Lee Chee Yang
7045fbd1f4 migration-guides: add release-notes for 4.0.7
(From yocto-docs rev: 65b2f85ff25fbf9d55ddf4be28b285dcf1bbaff0)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Suggested-by: Takayasu Ito <ito@lineo.co.jp>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-02-15 10:26:49 +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
86e9630511 dev-manual: fix old override syntax
(From yocto-docs rev: 48bd2ea8efe446b3694a3795b8083fe8783777aa)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-02-10 11:04:02 +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
Quentin Schulz
ebfc6bdba4 docs: kernel-dev: faq: update tip on how to not include kernel in image
Since commit f6d963fa6d ("kernel: make kernel-base recommend
kernel-image, not depend"), present in Kirkstone 4.0, one should
set RRECOMMENDS and not RDEPENDS to avoid including the kernel in the
image, so let's update the documentation to reflect that.

Reported-by: Konstantin Kletschke <konstantin.kletschke@inside-m2m.de>
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: b94956c7d416879f9e4c46102145ef478270c440)

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-01-06 17:33:45 +00:00
Quentin Schulz
cf42cc0ef0 docs: migration-4.0: specify variable name change for kernel inclusion in image recipe
Since commit f6d963fa6d ("kernel: make kernel-base recommend
kernel-image, not depend"), present in Kirkstone 4.0, one should
set RRECOMMENDS and not RDEPENDS to avoid including the kernel in the
image, so let's update the documentation to reflect that.

Reported-by: Konstantin Kletschke <konstantin.kletschke@inside-m2m.de>
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 775a3c7c56562fa8dd6a426008bce06ca1140e04)

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-01-06 17:33:45 +00:00
Michael Opdenacker
4641f83d93 manuals: add 4.0.5 and 4.0.6 release notes
(From yocto-docs rev: 61b2f039f09282a271abc1c41ea09765ea08a2cb)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-01-06 17:33: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
Mikko Rapeli
7a5685ad74 common-tasks.rst: fix oeqa runtime test path
It's "runtime/cases" in master and kirkstone.
If layer specific tests are in "runtime" directory,
they will not be found.

(From yocto-docs rev: 23dcf002eec5136427554112af8679fc2b98e61d)

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-12-01 19:16:38 +00:00
Michael Opdenacker
eaf8ce9d39 dev-manual: fix reference to BitBake user manual
Fix a wrong reference no longer tolerated by Sphinx 5.x
(missing "bitbake:" prefix)

(From yocto-docs rev: 8c2f9f54e29781f4ee72e81eeaa12ceaa82dc2d3)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-11 21:57:49 +01:00
Michael Opdenacker
c615d00a36 migration-guides: add 4.0.4 release notes
(From yocto-docs rev: df129c47f866b933af722b1214f3296a8cfe483b)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:51 +01:00
Michael Opdenacker
4837160315 poky.yaml.in: update version requirements
According to meta/classes/sanity.bbclass in Poky

(From yocto-docs rev: 2c6207606329c2b4ec56b7af538182ebf3c92792)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-05 08:47:28 +01: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
Michael Opdenacker
e0c806a65c migration guides: add missing release notes
(From yocto-docs rev: 23d3687c4cf71e878619a7bd7b95a9df944ca76c)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-08-31 12:17:41 +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
Michael Opdenacker
b373ad8405 docs: BB_HASHSERVE_UPSTREAM: update to new host
(From yocto-docs rev: f9a9c5cc721a79df7a39a6df8441739e3377fdc4)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-07-20 15:52:51 +01:00
Michael Opdenacker
c00f584817 manuals: switch to the sstate mirror shared between all versions
Following https://git.yoctoproject.org/poky/commit/?id=cf7d8894545b83f55420fa33f7848e1bfc6754ff

(From yocto-docs rev: 662294dccd028828d5c7e9fd8f5c8e14df53df4b)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-06-28 23:58:39 +01:00
Michael Opdenacker
27de52e402 migration-guides: release-notes-4.0: mention LTS release
(From yocto-docs rev: 4ec9df3336a425719a9a35532504731ce56984ca)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-29 19:10:10 +01:00
Nicolas Dechesne
c77f0ce695 migration-guides: stop including documents with ".. include"
This prevented variables from being substituted through the
code in yocto-vars.py, at least in the files included this way.

Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
(From yocto-docs rev: ac4e4b167964dd4548fb3d90cf9c63580a70b6e3)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-29 19:10:10 +01:00
Michael Halstead
d53ac6e956 set_versions: update for 4.0 release
Uncomment langdale lines to bump the version.

(From yocto-docs rev: b4cf85ac951b1d09b8698effaf62ba052e772eac)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-26 10:56:52 +01:00
Michael Halstead
3fbc631a44 releases: update for yocto 4.0
Bump various versions and names.

(From yocto-docs rev: bfb8b2cf4a79f898cdc97c6be7f3b47a5a411d84)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-26 10:56:52 +01:00
Lee Chee Yang
c68b8e1770 migration-guides: release-notes-4.0: update 'Repositories / Downloads' section
(From yocto-docs rev: e814a998cc0a7c451a77df0304d0a69a27ac08ae)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-25 15:22:12 +01:00
Quentin Schulz
02dc699d23 docs: migration-guides: release-notes-4.0: replace kernel placeholder with correct recipe name
If I am not mistaken, the only kernel recipe to have a new PACKAGECONFIG
option is linux-yocto-dev, in commit 1bac831fba
"linux-yocto-dev: introduce dt-validation PACKAGECONFIG".

Therefore, let's replace (kernel) by the one kernel recipe that has this
change.

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

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
Quentin Schulz
b43d659260 docs: migration-guides: release-notes-4.0: fix risc-v typo
It's RISC-V and not RiscV, c.f. https://riscv.org/ (yes, no dash in the
domain name...).

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

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
Quentin Schulz
3f5365d11a docs: migration-guides: migration-3.4: mention that hardcoded password are supported if hashed
Plaintext/clear passwords are not supported anymore but hashed passwords
still are. Mention that in the migration guide and point to the
appropriate location of documentation.

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

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
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
Quentin Schulz
4c2ea34b3e docs: conf.py: fix cve extlinks caption for sphinx <4.0
extlinks captions support using %s substitution but only from sphinx 4.0
onwards.
c.f. https://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html#confval-extlinks

Weirdly enough, on older sphinx versions, the caption is just a prefix
to the actual text passed to the extlink. Therefore, in that specific
case, CVE- or CVE-%s are identical in meaning for sphinx >=4.0 and since
only CVE- caption works on sphinx <4.0, let's go with CVE- caption
prefix.

Fixes: b311070d866cf "manuals: add 3.4 and 3.4.1 release notes after migration information"
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: c9922076f5c1285d9cfd6aff8ce5b6635d88222f)

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
eee7bbc16a migration-guides: add release notes for 4.0
Generated from commits in the kirkstone branch, as well as a few entries
from the migration guide.

(Note that the "Repositories / Downloads" section still needs to be
filled in.)

(From yocto-docs rev: 0c66638e61d3e16ac8d4b7ebc4ec6fb35625bf4f)

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
97bfd780ad migration-guides: complete migration guide for 4.0
* Make some corrections to preliminary set of entries
* Move out entries that were more appropriate for the release notes
  (i.e. that are more additions rather than changes that require the
  user to make changes)
* Add new entries based on commits in the kirkstone branch

(From yocto-docs rev: bea2da80e7c5338dc5abefe95ce27b80ed4ee98a)

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
Paul Eggleton
b80972f3ad migration-3.4: add missing entry on EXTRA_USERS_PARAMS
We missed noting this in 3.4 but I noticed the documentation was
recently updated, so note the removal.

(From yocto-docs rev: f661e62d6faf48dbb6c6fd9a61a6448ec339d2bf)

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
Quentin Schulz
273fe4b6af docs: sphinx-static: switchers.js.in: do not mark branches as outdated
Branches can never be outdated so let's check the release is not a
branch (branches end with .999).

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

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
Quentin Schulz
3947a5f18b docs: sphinx-static: switchers.js.in: fix broken switcher for branches
The switcher expects URL subpath to match the "release" used by sphinx
to build the documentation. Branches, however, are put in a subpath
after their name (e.g. dunfell) while sphinx sets the "release" to
X.Y.999. This means the switcher cannot replace correctly the path to
switch between releases/versions.

Let set_versions.py inject the list of release names into the
switchers.js.in file so it can check whether the subpath is one of the
release names in which case it needs to be stripped.

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

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
Quentin Schulz
4b8010810a docs: sphinx-static: switchers.js.in: rename all_versions to switcher_versions
This array only contains versions that can be selected through the
dropdown menu for switching between supported versions.

Therefore, let's rename it to switcher_versions to make its usecase
clearer.

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

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
Quentin Schulz
8096431d58 docs: set_versions.py: mark as obsolete only branches and old tags from obsolete releases
Branches are identified by their .999 version suffix which means they
will never be matched in the forloop above this git context. Therefore,
branches will match the condition. However, branches are not necessarily
obsolete (e.g. dunfell, honister and kirkstone today), so let's mark as
obsolete the branches which are from obsolete releases.

Old tags of currently supported releases are not defined as obsolete but
outdated, therefore using the series to which they belong like it is
done for branches is enough for obsolescence detection.

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

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
Quentin Schulz
ea99def6bf docs: update Bitbake objects.inv location for master branch
master branch of Bitbake is now located at docs.yoctoproject.org/dev
instead of docs.yoctoproject.org so let's update the switchers and
set_versions.py to reflect that change.

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

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
Quentin Schulz
ee6d170d87 docs: set_versions.py: fix latest version of an active release shown as obsolete
ourseries can be an active release and therefore shouldn't be marked as
obsolete. By adding ourseries to activereleases, it is impossible to
know if ourseries is actually an active release or not. Instead let's
loop on the active releases with ourseries too (only if it's not active
release, otherwise it'd appear twice).

Fixes: 6f40ef56054ec "docs: set_versions.py: add information about obsolescence of a release"
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: f16b633211b97b2cdf2c65d83c99cd3853d2bb5c)

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
Quentin Schulz
4a0acaf3cc docs: set_versions.py: fix latest release of a branch being shown twice in switchers.js
versions array is supposed to store the latest version of all active
releases. However, in the loop it is reassigned and therefore, the check
on whether our version is already in the versions array will always
return false (except for the latest version of the last active release)
and write our version again in the list.

By using a local variable for the logic instead of versions array, the
check now works properly.

Fixes: f2b069be8c307 "set_versions: Various improvements"
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 36a088c8c99dd37f5ca07ec8f90f2c51ef8b36f2)

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
Quentin Schulz
57a32692b7 docs: sphinx-static: switchers.js.in: improve obsolete version detection
Based on additional information per release, specifically with the
obsolescence status of a release, the obsolescence detection can now be
much smarter than just checking if the release is older than dunfell.

This is required because with LTS (dunfell for example) releases, it is
now possible to have LTS releases that are older than obsolete releases.

This means obsolete releases need to be tracked and only the release
version cannot be used as an indicator of obsolescence.

Let's use the obsolete field of the per-release data in the all_versions
dictionary to display correct warning messages.

The warning message is first about outdated version if there's a newer
one available (*even* if it is for an obsolete release, e.g. 3.0.1 will
say it's outdated and should select 3.0.4 version instead), then if the
version is the last of the release, show a warning message if the
release is obsolete.

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

Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-19 12:37:42 +01:00
Quentin Schulz
8643342d80 docs: set_versions.py: add information about obsolescence of a release
This adds support for marking releases as obsolete to make the
detection algorithm smarter (in a later commit) than just checking if
it's older than dunfell.

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

Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-19 12:37:42 +01:00
Quentin Schulz
7b3a83f736 docs: sphinx-static: switchers.js.in: remove duplicate for outdated versions
Since commit f2b069be8c307 "set_versions: Various improvements", an
outdated version will always appear in all_versions, meaning there'll
always be an exact match in the loop (just above the git context of this
patch) so there's no need to add the current_version to the dropdown
menu manually.

This issue showed up only for outdated versions of obsolete releases,
e.g. 3.2.3. In that case, 3.2.4 (latest version of the obsolete release)
will appear in the all_versions array in addition to 3.2.3, which means
the check on release series (3.2) will be matched twice, and 3.2.3 will
be printed once in the 3.2.4 loop because version != current_version and
once in the 3.2.3 because it is an exact match to an entry in
all_versions.

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

Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-19 12:37:42 +01:00
Abongwa Amahnui Bonalais
c6421fce9d dev-manual: add command used to add the signed-off-by line.
(From yocto-docs rev: 0520831118ab0f3287d1a6cde4fa26062e55ee74)

Signed-off-by: Abongwa Bonalais Amahnui <abongwabonalais@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-19 12:37:42 +01:00
Abongwa Amahnui Bonalais
0e27bdf640 documentation/brief-yoctoprojectqs: add directory for local.conf
Replacing local.conf by conf/local.conf

(From yocto-docs rev: 0f8c773d4ef79f7a8281c5743337c0504d7a786e)

Signed-off-by: Abongwa Bonalais Amahnui <abongwabonalais@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-19 12:37:42 +01:00
Richard Purdie
5fc8dd16f2 migration-guide: Kirkstone is now 4.0
Update the docs to reflect that kirkstone is 4.0, not 3.5.

(From yocto-docs rev: a6f571ad5b087385cad8765ed455c4b4eaeebca6)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-13 16:54:32 +01:00
Michael Opdenacker
a64ca37a13 migration-guides: preliminary description for 3.5
(From yocto-docs rev: 2c24dd801b8d9fa4b81726dcde34a69fde309e4a)

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
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
Michael Opdenacker
ecab5f3655 docs: add poky.yaml and sphinx-static/switchers.js to "make clean"
(From yocto-docs rev: 36d1be3db5f0c9c72aafdb414916ce5abc483f43)

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
Michael Opdenacker
01d846f21b overview-manual: add missing upper case
(From yocto-docs rev: 9de52ac713c89e3e7023148889c234d4ec4c6246)

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
Marta Rybczynska
54b7b0561e doc: migration-3.5: extend the section on inclusive language
Add the list of renamed and removed variables, show how the renaming
script works. Also mention the change in cve-check output.

(From yocto-docs rev: a0b55789035c8d44426b6ff8267b4042ef0a58ba)

Signed-off-by: Marta Rybczynska <marta.rybczynska@huawei.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
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
Daniel Ammann
b60b432d2c overview-manual: Fix reference
(From yocto-docs rev: 623bcfc66f42c334963bf51c262ef2fc5f9bbd91)

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
28f2442520 set_versions/switchers: Drop versions shown to the active releases
I believe we should only be showing the "active" versions in the switchers
base list of releases to show. Zeus and warrior are old and no longer actively
maintained and we don't suggest new users use them. gatesgarth is also
outside it's support window.

I therefore propose removing these leaving us with dev, honister, hardknott,
dunfell (LTS). In addition, any release that is selected will be shown, along
with any later release in that release series.

People can still navigate to the older docs using the releases list or by
direct URL but this highlights to users which releases we'd expect/encourage
them to be using.

(From yocto-docs rev: 5bcd6a632ba2ebace9c65fe8529f8f1de40226ce)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-31 11:46:03 +01:00
Michael Halstead
1c4b8ba2eb releases: update to include 3.4.3
Build scripts now only require updates in master.

(From yocto-docs rev: af6a15e376733727eb26c9c2a6b6a85f6faea437)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-31 11:46:03 +01:00
Richard Purdie
e0a812b2fe set_versions: Correct devbranch comparision
Correct the previous commit since we need to compare against ourseries
rather than ourbranch since devbranch would match against the series,
not the branch.

(From yocto-docs rev: 57f5ce5fe427e5387f6ac85225137463e51e5643)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-23 12:38:30 +00:00
Richard Purdie
c9d1536777 set_versions: Handle dev branch in switchers correctly
The dev branch is being displayed in switchers under two different
headings, 4.0.999 and dev (4.0). Add an additional conditional to fix that.

(From yocto-docs rev: 569815ac290f53a17330e53fb46c4870d8d247d2)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-23 12:29:42 +00:00
Richard Purdie
49a411edd4 Revert "set_versions/switchers: Drop versions shown to the active releases"
This reverts commit bf4e51fe5f.
2022-03-23 12:27:50 +00:00
Richard Purdie
13217f8b82 Revert "set_versions: Handle dev branch in switchers correctly"
This reverts commit f7d8533664.
2022-03-23 12:27:40 +00:00
Richard Purdie
bf4e51fe5f set_versions/switchers: Drop versions shown to the active releases
I believe we should only be showing the "active" versions in the switchers
base list of releases to show. Zeus and warrior are old and no longer actively
maintained and we don't suggest new users use them. gatesgarth is also
outside it's support window.

I therefore propose removing these leaving us with dev, honister, hardknott,
dunfell (LTS). In addition, any release that is selected will be shown, along
with any later release in that release series.

People can still navigate to the older docs using the releases list or by
direct URL but this highlights to users which releases we'd expect/encourage
them to be using.

(From yocto-docs rev: fdcdc50f3abf10aa702c958b8ba7ab6b19c57bff)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-23 12:08:56 +00:00
Richard Purdie
f7d8533664 set_versions: Handle dev branch in switchers correctly
The dev branch is being displayed in switchers under two different
headings, 4.0.999 and dev (4.0). Add an additional conditional to fix that.

(From yocto-docs rev: 569815ac290f53a17330e53fb46c4870d8d247d2)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-23 12:08:56 +00:00
Richard Purdie
d51fb3c8b9 set_versions: Various improvements
- Allow specifying the version from the commandline
- Add all previous release series/version mappings (to support transitions branch)
- Add poky mapping for 3.4 as some releases erronously use it
- Improve git branch 'guessing' code to work properly
- Handle poky '.0' release mappings correctly
- Only write poky.yaml if poky.yaml.in exists
- Ensure older non-active releases are shown in the switchers.js
  release list.
- Ensure current version and current release series are shown in switcher.

(From yocto-docs rev: f2b069be8c307e3efe518f5d9bb1e6e705b96554)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-23 12:08:56 +00:00
Richard Purdie
8827704443 set_versions/switchers.js: Allow switchers.js version information to be autogenerated
A horrible blunt hammer approach to updating the version information in
switchers.js based on the available tag information.

To merge and work correctly, this will need a change to the autobuilder-helper
docs generation code to pull the swicthers.js and script from master, then
to run the script. That should hopefully remove the need for other patching
even on old docs branches though.

(From yocto-docs rev: dc858c8b2ffdb792fe8cef05fab3d752aa858f78)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-23 12:08:56 +00:00
Richard Purdie
767eb1c71c set_versions: Add support for setting POKYVERSION found in older releases
(From yocto-docs rev: 9c7a4318920d468cca10448901868bad080cd895)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-23 12:08:56 +00:00
Richard Purdie
b04eda7447 conf.py/set_versions/poky.yaml: Set version in conf.py from poky.yaml
Allow conf.py to read the versions it needs from poky.yaml and have
set_versions.py write this out. This means we don't have to change as
many files when making new releases.

(From yocto-docs rev: bfe74c67f327f0c6445cb4129ee0c32db022b95a)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-23 12:08:56 +00:00
Richard Purdie
8d3e9aaede Makefile/set_versions: Allow poky.yaml to be autogenerated
Use a script to generate the branch/tag information inside poky.yaml.

If the branch isn't a known release branch, include git magic to find
the closest matching release branch we know about.

(From yocto-docs rev: 841e2df0e2e544b82fff9ddd0339a4e775148e3a)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-23 12:08:56 +00:00
Michael Halstead
c41172d837 releases: update to include 3.1.15
Adding 3.1.15 to documentation switcher and release list.

(From yocto-docs rev: 355dd1e3f5bf76244a0b5862475cb06ace1c87b9)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-22 22:32:34 +00:00
Richard Purdie
3b8d67d4f0 poky.yaml: Drop unused YOCTO_DOC_VERSION_MINUS_ONE
This doesn't seem to be used anymore and doesn't make much sense,
remove it.

(From yocto-docs rev: 89176e0bd45453ebb7ac77ce6fa333cb94f0cfcc)

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
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
6f713552b5 doc: migration-3.5: variable changes for inclusive language
(From yocto-docs rev: a6650fd55259c5d7cf3cf9579e9ecd1184b1b155)

Signed-off-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
1b719e9043 doc: migration-3.5: move the distutils changes to the class changes section
(From yocto-docs rev: 2289b74b0cc4d991445ed6fbd01b7e17cb630fc3)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-21 15:18:24 +00:00
Nicholas Sielicki
2fd4d2cb70 dev-manual: note on using journald without syslog
journald is not a syslog provider, so using journald exclusively amounts
to just preventing a syslog provider from being specified on a system
where journald is active.

Various spots where this has popped up:
* https://stackoverflow.com/q/48746397
* https://lists.yoctoproject.org/g/yocto/topic/82883035#53548

(From yocto-docs rev: aba38d5dc2db708ed6e8fc6dca4d869fe7fe855c)

Signed-off-by: Nicholas Sielicki <nicholas.sielicki@legrand.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
e3b7a5ba49 docs: brief-yoctoprojectqs: update video tutorial
Replace a 10 year-old introduction to the Yocto Project
by the most recent one from Behan Webster and Tom King (Dec. 2021).

(From yocto-docs rev: 92a573d690c82fb9ff717e68af5ee09da33cea2c)

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
61f3805d0e dev-manual: details about using firewalls and limiting fetch threads
Fixes [YOCTO #13235]

(From yocto-docs rev: cf76420c50f13762fb800a19931a8af5ae3567cf)

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
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
88e368dca4 documentation/README: correct heading styles actually used in the YP manuals
Sphinx seems to offer flexibility in heading styles definitions,
but the new text matches the way subsubsections and subsubsubsections
are defined in the current manuals.

Note that it's not possible to mix different definitions, for example
by using "~~~~" and "^^^^" for subsubsections in different places.

(From yocto-docs rev: 89a9af58adaa4cf4708d0383655b992f8c7239e2)

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
Tony McDowell
d59439a3fb dev-manual: add instructions for compacting WSLv2 VHDX files
Using DiskPart for the systems which lack optimize-vhd

(From yocto-docs rev: c692b77065e6bd8eda789a88fa8fae1351a7274d)

Signed-off-by: Tony McDowell <svet.am@gmail.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
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
de54ea299b docs: migration-3.5.rst: fix "distutils" typo
(From yocto-docs rev: 76755cd4e2122a4a96b33c482c30e2bcd6ee9a7f)

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
Michael Opdenacker
d43121dac5 docs: overview-manual: formating fixes
(From yocto-docs rev: c17eb6bb35053ad89e52d41c7da75ccbc3823d1b)

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
Michael Opdenacker
2ea66dc0f6 documentation: release notes for 3.4.2
(From yocto-docs rev: 2a29dfa30452ae4def9a9c6047e95b4dce2a4946)

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
Michael Opdenacker
43fbe48298 documentation: individual release note files
This makes changes and new files easier to review

(From yocto-docs rev: f3f76236b5c003481a0f211b60a8df9479db833b)

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
Michael Opdenacker
d369a3cfc6 documentation/README: how to upgrade Sphinx packages
(From yocto-docs rev: 199c6ef4b64d6c7f672ac183d3bf73c8ff3bb2c7)

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
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
e2218a9684 docs: migration-3.3 drop distutils labels, terms
The distutils* classes and DISUTILS* terms are no longer defined so
replace their usage with ``text``.

(From yocto-docs rev: c0e0e0b9416cb7a2fed3efe9d32ee905b6391f24)

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
48e3604317 docs: migration-2.6 drop distutils labels, terms
The distutils* classes and DISUTILS* terms are no longer defined so
replace their usage with ``text``.

(From yocto-docs rev: 6be0ab803e6dd64e4a044b7c605acfdd45caa280)

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
aa824e54d4 docs: migration-3.5: distutils move
The distutils*.bbclasses have been dropped from oe-core and moved to
meta-python.

(From yocto-docs rev: dac8ac065e76b9c933eefb52c91d4b9a2e501942)

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
Michael Halstead
0447aace57 releases: update to include 3.3.5
Adding 3.3.5 to documentation switcher and release list.

(From yocto-docs rev: 78545b8f42657c21bc3cac96429d3950b07a3aca)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-03 09:19:58 +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
Michael Halstead
41ae26ecab releases: update to include 3.4.2
Adding 3.4.2 to documentation switcher and release list.

(From yocto-docs rev: 6ffc51362a8fd028429359eb9da57c87b270584d)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-02-21 16:46:22 +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
4760c3e264 manuals: add 3.4 and 3.4.1 release notes after migration information
Only done for release 3.4 and 3.4.1 so far.
Release notes are kept under the migration-guides/ directory for
the moment, for easier reviewing.

(From yocto-docs rev: b311070d866cf4ab51c72ff3ac7bc41ea3e932cb)

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
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
Christian Eggers
b6c1329501 dev-manual: update example from kernel.bbclass
Since f748564653 ("kernel: provide virtual/kernel for all kernels"),
all recipes which inherit kernel.bbclass provide "virtual/kernel",
independent of the value of `KERNEL_PACKAGE_NAME`.

(From yocto-docs rev: da69e75c7f84f51c8fa95e9217e11b4b36af52d6)

Signed-off-by: Christian Eggers <ceggers@arri.de>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-02-18 17:58:02 +00:00
Michael Halstead
d09e2e05a0 releases: update to include 3.1.14
Adding 3.1.14 to documentation switcher and release list.

(From yocto-docs rev: 4b2cfbc517208d6df40104d25e62f8febdd76a7f)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-02-17 11:47:24 +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
Peter Kjellerstedt
0c8ad5dc5e test-manual: Correct two references to BB_SKIP_NETTESTS
The environment variable used to disable network tests when running
bitbake-selftest was incorrectly referred to as BB_SKIP_NETTEST.

(From yocto-docs rev: 4a2252cf412ea2aa26209d835c96661a772b6d31)

Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
Reviewed-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-02-03 13:47:50 +00:00
Michael Opdenacker
de069431bf manuals: propose https for SSTATE_MIRRORS
Both http and https work, but https should raise fewer questions
from users.

(From yocto-docs rev: e3bf892b1328b5c43ab041ba6c850e2782f54bdf)

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

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

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

- Simplifying a few class section links

(From yocto-docs rev: 29d66aaa898390c19f121baf0f4fdcc178e4cd80)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-02-03 13:47:50 +00:00
Michael Opdenacker
a9fdd010b9 dev-manual: new "working with pre-compiled libraries" section
This explains how to deal with versioned and unversioned
pre-built libraries from vendors.

Content and examples adapted from
https://wiki.yoctoproject.org/wiki/TipsAndTricks/Packaging_Prebuilt_Libraries,
originally written by Henry Bruce in 2016.

(From yocto-docs rev: 5e46cad9e4b4ab03e33f4d5aea34e56f6b15fe27)

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
3f27dfa9c9 dev-manual: stop mentioning the Angstrom distribution
Now defunct

(From yocto-docs rev: 52f7aedda58becb081eeca4a1bc02068f72d7c4a)

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
e4e58669f0 migration-3.5: mention task specific network access
(From yocto-docs rev: d8573e8a36eef61be1c9e7706c38ed28ca4c9962)

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
Robert Joslyn
f299005d66 dev-manual/common-tasks: Fix typo
direction -> directory

(From yocto-docs rev: 441151bfdeda6eccf46a7829d1a3181e83d441a8)

Signed-off-by: Robert Joslyn <robert.joslyn@redrectangle.org>
Reviewed-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
e1ce6432f9 dev-manual: stop mentioning nightly builds
While nightly builds are still run, they only produce
test files and reports. They are no longer a solution
to use the latest code.

(From yocto-docs rev: ace9f81ade851bb1b0d98a050007fffbc62b938d)

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

(From yocto-docs rev: bf98f5a15c33e75315cd14e653f253ef078da614)

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

Deprecate distutils3* classes.

[YOCTO #14610]

(From yocto-docs rev: 0e9838e5a2096932d081a9a05a25c4fa0d6dc714)

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

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

[YOCTO #14610]

(From yocto-docs rev: 4e8c911b73f511f1fb7b557f12d5c87129bc2593)

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

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

[YOCTO #14610]

(From yocto-docs rev: 6a314a9217206f572289b484e59076483391868c)

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

(From yocto-docs rev: e3f438e4a71b155bd09bc7988c8e5626a063fde3)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-17 11:59:50 +00:00
Michael Opdenacker
8dbd3a1757 migration-guides: prepare for release 3.5
(From yocto-docs rev: e0bef3c086645127b743d127b8f6e8925138b9dd)

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

(From yocto-docs rev: 84001d5d4258dad9e3663ea842ecc291d9e1a7dd)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-10 23:12:43 +00:00
Michael Opdenacker
fdbbdda7e5 dev-manual: update bitbake.conf sample for static libs
(From yocto-docs rev: 0762a24cb20e23d4903402bea109ae8d1d85ef5e)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-10 23:12:43 +00:00
Michael Opdenacker
76ab2eab31 manuals: document hash equivalence
(From yocto-docs rev: 7fad0873207980a747f79b2ce29ec0dc6c6c3cdf)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-10 23:12:43 +00:00
Tim Orling
35a14725d6 poky.yaml: centos-7 python36-pip -> python3-pip
In CENTOS7_HOST_PACKAGES_ESSENTIAL, change python36-pip to python3-pip.

The python36-pip package was obsoleted by python3-pip in RHEL 7.7+

6771a1c54f

(From yocto-docs rev: df5d499f86e0cf2b6316778c7c390d64f5f1367c)

Signed-off-by: Tim Orling <tim.orling@konsulko.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-10 23:12:43 +00:00
Michael Opdenacker
0cda4b934d documentation/README: trivial typo fix
(From yocto-docs rev: f3f252c08a8ae9b492d766fd8a7168baf7467a07)

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

(From yocto-docs rev: de1156b6d95a2d1738807f0b0525edd0b58fc0e9)

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

(From yocto-docs rev: 5720fb534dc343675f8be6369b9661512e3968f2)

Signed-off-by: Robert Joslyn <robert.joslyn@redrectangle.org>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-07 11:12:06 +00:00
Michael Opdenacker
5e5252bf13 quick start manual: update Share State and Hash Equivalence settings
(From yocto-docs rev: 8668f070a5f2bf70f71f1ac53d2fac1b0faff82d)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-07 11:12:06 +00:00
Michael Opdenacker
36d200ab0a manuals: replace "rootfs" by "root filesystem"
Almost everyone understands "rootfs", but "root filesystem"
is real English.

(From yocto-docs rev: 3d610f15e5b6be3435e9e81e4498a676671e5b39)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-07 11:12:06 +00:00
Michael Opdenacker
620ba2535c overview-manual: fix typo
(From yocto-docs rev: 595d3e77855aeed31537a5e58a4426d7cc0b21f5)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-07 11:12:06 +00:00
Michael Opdenacker
dd938fbbdb documentation: add comment to releases.rst switchers.js
To let release developers know that they don't need
to update these files in release branches other than "master".

(From yocto-docs rev: 00f71afae92e5967a0422824841d4d4db682d235)

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

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

Signed-off-by: Vyacheslav Yurkov <uvv.mail@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-07 11:12:06 +00:00
Michael Halstead
56e5054a60 releases: update to include 3.1.13
Adding 3.1.13 to documentation switcher and release list.

(From yocto-docs rev: 24fe6a752cdec66a3d34d390fa645726ed3725b8)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-03 22:17:18 +00:00
Quentin Schulz
c7c5fc879c documentation: conf.py: add knob for loading appropriate objects.inv
Yocto Project releases use a specific Bitbake release. Currently the
bitbake: mapping is pointing to the current master version of Bitbake
documentation. This is an issue if some links disappear over time and
someone is still building old documentation (which is the case on the YP
autobuilder for example). Also, the documentation at the current master
version of Bitbake might not be correct for the Yocto Project version
associated with the doc the user is currently looking at, potentially
causing confusion.

In master branch, nothing needs to be done. For release branches, the
bitbake_version variable needs to be set accordingly. See
https://wiki.yoctoproject.org/wiki/Releases for the mapping.

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

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>
2021-12-13 23:31:34 +00:00
Quentin Schulz
e6f8c401aa docs: dev-manual: common-tasks: highlight creating your own layer is not required
Three's been some feedback saying that people actually missed that
paragraph and thought creating the layer by hand was the only way to do
it instead of leveraging bitbake-layers create-layer tool.

Let's try to make it a bit more obvious one does not need to create the
layer by hand by putting the paragraph into a note.

(From yocto-docs rev: 2b171d267ae37d467f8437c4739f32e5253049b3)

Signed-off-by: Quentin Schulz <foss@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-12-13 23:31:34 +00:00
Quentin Schulz
e71983bc7d make the documentation a bit more inclusive
Except the name of variables which can't be changed only in the
documentation for obvious reasons and workflow or developement
explanations around the use of the "master" branch which cannot be
replaced with "development" branch instead, most of the non-inclusive
words that appear in https://inclusivenaming.org/word-lists/tier-1/
should have been replaced in this patch.

(From yocto-docs rev: 2755f35060084f7af356091de9dc144f85530fe2)

Signed-off-by: Quentin Schulz <foss+yocto@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-12-13 23:31:34 +00:00
Michael Opdenacker
99474e0d68 ref-manual: remove newline string in PREMIRRORS
According to the syntax simplification brought by
https://git.openembedded.org/bitbake/commit/?id=044fb04d

(From yocto-docs rev: 19090efa1268fcb1fcfd3a2dc637d10d8a50dfad)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-12-13 23:31:34 +00:00
Michael Opdenacker
d21c35bd81 misc manuals: add further class references
(From yocto-docs rev: 0693f1f8466a118dc707a9c17d5ca528b4ea368a)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-12-13 23:31:34 +00:00
Michael Opdenacker
121f5758ab ref-manual: add more class references
(From yocto-docs rev: f4610b060968c481c68d0411b82201c302050b71)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-12-13 23:31:34 +00:00
Michael Opdenacker
a19add4aaa migration-guides: add more class references
(From yocto-docs rev: 29031a9da0f1a500a8b2b6a642ee553a352255f8)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-12-13 23:31:34 +00:00
Michael Opdenacker
2b578eae4e dev-manual: how to purge duplicate sstate cache files
(From yocto-docs rev: 113400eb47c13617f08b415bc9ddb4526429049c)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-12-13 23:31:34 +00:00
Michael Opdenacker
b7693b7321 manuals: add hyperlinks to files in meta-skeleton
This makes the manuals easier to use.
Note the care to keep the paths visible, so that people
reading a printed version still know where to find the files.

(From yocto-docs rev: 501917f65530f14ea686b69d6e96407c3f970a28)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-12-13 23:31:34 +00:00
Anuj Mittal
d9e5f67c5f releases.rst: move gatesgarth to outdated releases section
(From yocto-docs rev: 0a21e78e4593ef2417f4a08b23246ad3c93a566e)

Signed-off-by: Anuj Mittal <anuj.mittal@intel.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-12-13 23:31:34 +00:00
Michael Opdenacker
79fbaf8b04 dev-manual: remove warning about += and :append
No longer necessary since a warning was added to BitBake
(https://git.openembedded.org/bitbake/commit/?id=8c31e75557dc6a8d8f407b5d24d6327889a3e3b1)

(From yocto-docs rev: f3069c927f24c5d1942c9bcc4f55bb77cd262c0e)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-12-13 23:31:34 +00:00
Michael Opdenacker
6a353d9322 ref-manual: drop support for Fedora 30-32
These versions have reached their end of life
and we don't test them any more.

(From yocto-docs rev: e4ff50fadbf61bf29015e9eded2584731c5d2bb2)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-12-13 23:31:34 +00:00
Michael Opdenacker
6df1694cd4 ref-manual: drop support for Ubuntu 16.04
There are no more free updates to Ubuntu 16.04
We can no longer test the latest updates to this distro.

(From yocto-docs rev: 752636d8924f0aaae1e8df61affef3310ae91aa0)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-12-13 23:31:34 +00:00
Michael Halstead
14cb87f9ae releases: update to include 3.4.1
Adding 3.4.1 to documentation switcher and release list.

(From yocto-docs rev: 7d503d765f5a8ade226c897a17aecd0856104af1)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-12-12 11:27:24 +00:00
Steve Sakoman
35cdb70406 ref-system-requirements.rst: Add openSUSE Leap 15.2 to list of supported distros
(From yocto-docs rev: 895ce3b9dda96a049c92754cf06eb34635097861)

Signed-off-by: Steve Sakoman <steve@sakoman.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-11-21 11:07:01 +00:00
Michael Opdenacker
2a550cceae documentation: prepare for 3.1.12 release
(From yocto-docs rev: d97525982602db05e31b89a9076c93420974fd68)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-11-21 11:07:01 +00:00
Steve Sakoman
f4de0f7fcd ref-system-requirements.rst: Add Fedora 33 and 34 to list of supported distros
(From yocto-docs rev: b85b532b8360756798c08482b94758d5df55f5ed)

Signed-off-by: Steve Sakoman <steve@sakoman.com>
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-11-21 11:07:01 +00:00
Steve Sakoman
941a08f379 ref-system-requirements.rst: Add Debian 11 to list of supported distros
(From yocto-docs rev: aa212ce6c6fb9b92e0cf4e32ae8d2458aab4a055)

Signed-off-by: Steve Sakoman <steve@sakoman.com>
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-11-21 11:07:01 +00:00
Michael Opdenacker
ed2880fbda ref-manual: simplify SRC_URI reference
After some features that also apply to BitBake
were moved to the BitBake manual.

(From yocto-docs rev: 1415521656427f351ab2d3f8bc498130c4653396)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-11-21 11:07:01 +00:00
Michael Opdenacker
ea0bc63dec ref-manual: BBFILES_DYNAMIC - fix punctuation and quoting issues
(From yocto-docs rev: a798e1172ac507549ad36c0cfd4b92f53a1bef87)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-11-21 11:07:01 +00:00
Michael Opdenacker
5c85099acc ref-manual: remove reference to TOPDIR
Already described in BitBake's manual
As it is not specific to OE / Yocto Project

(From yocto-docs rev: 150d5e938e9f413ade8bd6211ee7d55a2819a431)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-11-21 11:07:00 +00:00
Robert P. J. Day
7e8f513910 ref-manual: generalize definition of "container layer"
Given that there seems to be little value in being excruciatingly
pedantic about whether a container layer has a valid layer as a
top-level directory, expand the definition to allow either.

(From yocto-docs rev: 95e5df9a51a7cda6588af523a3a0d6752613f189)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-11-21 11:07:00 +00:00
Michael Halstead
63dc9002b6 releases: update to include 3.3.4
Adding 3.3.4 to documentation switcher and release list.

(From yocto-docs rev: 468e8bfb4b9bed662f1b32b0563339d0816a7e98)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-11-19 11:05:20 +00:00
Michael Opdenacker
eec7affb53 manuals: start of documentation standards document
This first version specifies how to create consistent SGV graphics

(From yocto-docs rev: 370b9e34e9092c9eed22df2e8b2d0bb979487e5c)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-11-07 10:44:52 +00:00
Ross Burton
3c3e8c4f39 kickstart: update busybox note regarding PARTUUID
As of oe-core c996cabf the default BusyBox configuration supports
PARTUUID, so update the note to reflect this.

(From yocto-docs rev: cfd0498c6a981bcdc4b6bd03cb5f8dd42f0b39fc)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-11-07 10:44:52 +00:00
Vyacheslav Yurkov
683a7db46d ref-manual: update overlayfs class
Describe how to use a generated helper service to set up a proper
systemd dependency chain.

(From yocto-docs rev: c8c1f7e852830dae4468da70e1ac732d7bbce06f)

Signed-off-by: Vyacheslav Yurkov <uvv.mail@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-11-07 10:44:52 +00:00
Michael Opdenacker
fdcbca09f8 manuals: correct "take affect" by "take effect"
(From yocto-docs rev: aeaf46f78b940744ce2e160e78b244395087e8e7)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-11-07 10:44:52 +00:00
Ross Burton
f8f44cb476 ref-manual: improve documentation for SDKMACHINE
(From yocto-docs rev: 69bfb07772e7d358bb532191189a2518d1046178)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-11-07 10:44:52 +00:00
Michael Halstead
0d4c97c24d releases: update to include 3.4 honister
Adding 3.4 to the release switcher and incrementing dev to say 3.5.

(From yocto-docs rev: a171e88bc572e45d700d257a9de521520b4d5d5e)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-10-26 14:04:19 +01:00
Michael Opdenacker
bdc84d86aa docs: poky.yaml: updates for 3.4
(From yocto-docs rev: d080c62f3ec489275b2f241ccea51cf127f4f782)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-10-22 22:15:33 +01:00
Michael Opdenacker
5e529aefde releases.rst: fix release number for 3.3.3
(From yocto-docs rev: 8e0e33663b4f7e58b02e3b5153e4164a7d3db20e)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-10-22 22:15:33 +01:00
Daiane Angolini
634b7f1fdc ref-manual: Update how to set a useradd password
Partial fix for [YOCTO 14605]

(From yocto-docs rev: 3f3e5574ac9801ad92940168b61b532e0bd53a80)

Signed-off-by: Daiane Angolini <daiane.angolini@foundries.io>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-10-22 22:15:33 +01:00