Commit Graph

6391 Commits

Author SHA1 Message Date
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
Paul Eggleton
fd6e9609d1 migration-3.4: add some extra packaging notes
Add some notes on minor packaging changes that I missed earlier.

(From yocto-docs rev: a4f345f888b466bd1459b767c1b8cf8b9397e27e)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
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
Paul Eggleton
a43cb3d607 poky.yaml: fix lz4 package name for older Ubuntu versions
It turns out that for Ubuntu, lz4 is the valid package name for newer
versions (e.g. 20.04 LTS) but not for older ones (e.g. 18.04 LTS, where
the correct package is liblz4-tool). In 20.04 the lz4 package includes
liblz4-tool in its "provides" so it's best to list that one for now.

(From yocto-docs rev: 2a4e259d2786c14b19a632b3a8f1a06383b6a80c)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
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
Michael Opdenacker
002967ee23 ref-manual: fix description of SOURCE_DATE_EPOCH
Update the reference to the code that computes this default
value for this variable.

(From yocto-docs rev: b115a1c07f76d2cca37565ac678c21e0e6056fff)

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
90b29420c7 ref-manual: document SOURCE_DATE_EPOCH
(From yocto-docs rev: 160d672641c52338ba499edfb66339a10b088490)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-10-20 20:22:20 +01:00
Michael Opdenacker
07108739ce manuals: rename "devpyshell" to "pydevshell"
This addresses [YOCTO #14531] after the "devpyshell" task was renamed
to "pydevshell" in OE core.

(From yocto-docs rev: 1056320e90545c8dff0fc71a5fde752295d4d6e4)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-10-20 20:22:20 +01:00
Michael Opdenacker
5550d83ff7 ref-manual: document TOOLCHAIN_HOST_TASK_ESDK
(From yocto-docs rev: 2adac164a2d4cf23c0372c1154709f2866d483fa)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-10-20 20:22:20 +01:00
Paul Eggleton
b2170a460b migration: tweak introduction section
Ensure we have a brief introductory section and tweak the general
migration considerations a little.

(From yocto-docs rev: b127348bbc6a7a6e48ee14434fffc56e08aa9e02)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-10-20 20:22:20 +01:00
Paul Eggleton
64f1f876a1 migration-3.4: add additional migration info
Add migration instructions gathered by combing the commits in this
release.

(From yocto-docs rev: 2fc89fa1d4e29d2498d5b736ffe85c1cdc8b62e7)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-10-20 20:22:20 +01:00
Paul Eggleton
9ababc0b5b poky.yaml: add lz4 and zstd to essential host packages
These are now required so update the corresponding distro-specific
lists used in the system requirements documentation.

(From yocto-docs rev: 604deb5c30a8808a60187f81645fa08b67ef2de9)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-10-20 20:22:20 +01:00
Paul Eggleton
9b0f90ff6a ref-manual: remove meta class
This was recently removed so remove the reference to it.

(From yocto-docs rev: 53f52adf212e35e7588a90e94b03b5cfae6f867c)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-10-20 20:22:20 +01:00
Paul Eggleton
1088e2d9d1 migration-3.4: tweak overrides change section
Minor grammar and readability improvements.

(From yocto-docs rev: e33a809d139d52a8aa262a25fe3031a8882dee2e)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-10-20 20:22:20 +01:00
Michael Opdenacker
96594eb948 dev-manual: warn about license compliance issues when static libraries are used
This partly addresses [YOCTO #14407]

(From yocto-docs rev: 444ca8900e8057562d2a71a77e6e6798aca3ce85)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-10-08 22:01:25 +01:00
Michael Opdenacker
6118a0510a dev-manual: correct NO_GENERIC_LICENSE section title
(From yocto-docs rev: 522841b4715295c6f399fc5affe2ade128d139ae)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-By: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-10-08 22:01:25 +01:00
Michael Opdenacker
e467ddd9e2 overview-manual: simplify expression
(From yocto-docs rev: ea1e5d4214f30927119f0124ee8a80a558601161)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-10-08 22:01:24 +01:00
Jon Mason
c46317a30e dev-manual: remove errant /
(From yocto-docs rev: 5a10c78c574eae48f50f5c912fd6534bdf99f71c)

Signed-off-by: Jon Mason <jdmason@kudzu.us>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-10-08 22:01:24 +01:00
Jon Mason
0638b77576 documentation: use YOCTO_DL_URL
(From yocto-docs rev: e3ad609d9fce8d6729bf6cb553993bddba1785ae)

Signed-off-by: Jon Mason <jdmason@kudzu.us>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-10-08 22:01:24 +01:00
Jon Mason
58645b0586 documentation: replace http with https for URLs
https has been the preferred way to access websites for many years now.
Change all of the URLs with a _working_ https server/certificate to use
that URL.

(From yocto-docs rev: c77868c780df94356d5f21453f80ace073fade9b)

Signed-off-by: Jon Mason <jdmason@kudzu.us>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-10-08 22:01:24 +01:00
Michael Opdenacker
8c5c32619a manuals: introduce 'yocto_sstate' extlink
(From yocto-docs rev: f428c8d3bb12bfdb2b2afb03e0e6b80e28fd0e62)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-10-08 22:01:24 +01:00
Michael Opdenacker
6910fceb7a docs: add "make all" to build old types of docs (html, epub, pdf) at once
(From yocto-docs rev: 8ce6aa0d4c0985e187464c7578662ff7581bc9ce)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-10-08 22:01:24 +01:00
Michael Opdenacker
9c70174e5c overview-manual: SVG diagram for the git workflow
Set in full-width mode to make it ready in PDF
and EPUB outputs.

(From yocto-docs rev: 394c7c26c6591153670c67740d9a64f54725321b)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-10-08 22:01:24 +01:00
Michael Opdenacker
858a9af30f conf.py: use PNG first in EPUB output
SVG directly included in EPUB output has multiple issues,
in particular font size and alignment ones (tested on two
EPUB readers). Instead, using PNG, generated from SVG when available
as the primary format for images. GIF and JPEG are fine too.

(From yocto-docs rev: ff3876ca4910cf61bc25bfeb07e65ad6f6a93b48)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-10-08 22:01:24 +01:00