Commit Graph

6391 Commits

Author SHA1 Message Date
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