Commit Graph

6026 Commits

Author SHA1 Message Date
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
Michael Opdenacker
bca3caeaea Makefile: allow epub and latexpdf outputs to use diagrams from SVG sources
html output is great when directly using SVG
epub output has to use exported PNG because of issues using SVG directly
latexpdf output cannot use SVG, it needs exported PDF instead

This adds rules to generate PNG and PDF formats from new SVG sources.

Newly added diagrams have be stored in svg/ subdirectories
so that PNG and PDF files generated from SVG can be "gitignored"
without ignoring the original PNG diagrams that have no SVG source.

Note: had to remove the dependency to "Makefile" in the final "catch-all" target,
otherwise it was also catching the SVG to PNG and SVG to PDF targets.

(From yocto-docs rev: cd9bbd41d323bc124057396f142010509c65bbaf)

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
33ea53f00d manuals: replace "apt-get" by "apt"
Modern Debian based distros (such as Ubuntu) now
use "apt" instead of "apt-get"

Also make sure "apt" is invoked with root privileges (mandatory)

(From yocto-docs rev: 380ef2474f3ecc2bce83f11cd838d054bef56d22)

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:24 +01:00
Jon Mason
4ca20be7fe documentation: update sources mirror URL
The URL for the sources mirror no longer works.  Update to the new
location.

(From yocto-docs rev: 616c326437c03d7f4530168c4c9d6ef50743952e)

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
60b02e9daa ref-manual: document DEBUG_PREFIX_MAP
Fixes [YOCTO #14433]

(From yocto-docs rev: 23eb07c26044d06bc51c757bf1b0a53b1b357dc8)

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
f7a8e145e9 manuals: font fixes
This fixes font inconsistencies, mixing a ``text`` string
with another string with the regular font, where the whole string
makes more sense with a single font.

The result is also much simpler and will make future
searches easier.

(From yocto-docs rev: e6d1c166a97a1b6bb42ca49dfcbd3d39f8eadc16)

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
Robert P. J. Day
6c29f198d9 overview-manual: delete bad backslashes in SSTATE_MIRRORS example
Two inappropriate backslashes in the example for setting
SSTATE_MIRRORS are apparently the result of an error by the
transmogrification script for migrating XML to rST.

(From yocto-docs rev: 9cff301a768b248f19fc1d5834f04d3defffcbc7)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-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-02 09:57:41 +01:00
Daniel Wagenknecht
b82097b9c0 ref-manual: add note about license implications of bundled initramfs
Ensure users are aware that usage of INITRAMFS_IMAGE_BUNDLE is only
appropriate for use with GPLv2 compatible software.

(From yocto-docs rev: ecf4582b454aa301905f0f9e3c6f5adb98dc1991)

Signed-off-by: Daniel Wagenknecht <dwagenknecht@emlix.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-10-02 09:57:41 +01:00
Daniel Wagenknecht
b0eedf4dca common-tasks: add note about license implications of bundled initramfs
Ensure users are aware that usage of INITRAMFS_IMAGE_BUNDLE is only
appropriate for use with GPLv2 compatible software.

(From yocto-docs rev: 1859654663ebb3b051fb6c4da4dc76f0dd46c47c)

Signed-off-by: Daniel Wagenknecht <dwagenknecht@emlix.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-10-02 09:57:41 +01:00
Robert P. J. Day
65cfd937a2 ref-manual: mention INHIBIT_PACKAGE_DEBUG_SPLIT variable
Following a detailed discussion of PACKAGE_DEBUG_SPLIT_STYLE, it seems
only appropriate to refer the reader to INHIBIT_PACKAGE_DEBUG_SPLIT.

(From yocto-docs rev: d12a6149ed9ec4a5f7c47f4a8c0330c6024c9de5)

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-10-02 09:57:41 +01:00
Quentin Schulz
f25e408268 ref-manual: fix missed override syntax change
Cc: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 527e885fa9beedbdcf9942d0d227862af55fcc40)

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-10-02 09:57:41 +01:00
Robert P. J. Day
b6b6e81db1 ref-manual: extend explanation of PACKAGE_DEBUG_SPLIT_STYLE
The current explanation of this variable seems incomplete, so be a
bit more verbose to make sure the reader understands the packaging
possibilities.

(From yocto-docs rev: 1914705f062b232c10624c11fc85935cc454d2eb)

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-10-02 09:57:41 +01:00
Michael Halstead
0afeb9f740 releases: update to include 3.1.11
Adding 3.1.11 to documentation switcher and release list.

(From yocto-docs rev: 29fb29547322520698b13a4d7c94dbb8defa93b1)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-09-28 07:49:57 +01:00
Michael Halstead
ab55ae5d39 releases: update to include 3.3.3
Adding 3.3.3 to documentation switcher and release list.

(From yocto-docs rev: cc88f73ea0e38f536cb3e05b504df80048856a84)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-09-18 13:35:32 +01:00
Robert P. J. Day
f14b77b8ff dev-manual: update output of "wic list images"
Output order from "wic list images" is in different order, and was
missing a couple entries.

(From yocto-docs rev: 7df7356b8a306d7e77f0aab1f443fd1306c25620)

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-09-18 13:03:45 +01:00
Robert P. J. Day
b7030dd10e dev-manual: emphasize that new layers live outside of poky
Tweak the bblayers.conf example to encourage the reader to appreciate
that any new layers should not share space with the official Poky
checkout.

(From yocto-docs rev: 46931f8497c3c4b874613acbe7c9612944174559)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-09-18 13:03:45 +01:00
Michael Opdenacker
badb6c6fb4 ref-manual: update "devtool check-upgrade-status" output
This command now uses "INFO" insted of "NOTES" and output
information in columns. Also good to show more recent
versions of recipes.

(From yocto-docs rev: d875083150ac30b884d823e9f0f568d3a92ddcc1)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-09-18 13:03:45 +01:00
Michael Opdenacker
6a9e7fb010 ref-manual: improve documentation for RECIPE_NO_UPDATE_REASON
This add a description of this variable to the variable index,
and clarifies the explanations given in the devtool reference
section.

(From yocto-docs rev: 034b976addd0db6da31c4bacdbea21f2d47c00dc)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-09-18 13:03:45 +01:00
Michael Opdenacker
6c5986ebfe ref-manual: improve "devtool check-upgrade-status" details
- Mention "devtool latest-version recipe" to process a single version
- Explain that the mechanism is controlled by the UPSTREAM_CHECK*
  variables, which are not referred to anywhere else in the manuals,
  except in the variable index.

(From yocto-docs rev: eded237f1a1ec7df3f9910242bfa4b3818ff3e58)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Alexander Kanavin <alex.kanavin@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-09-18 13:03:45 +01:00
Michael Opdenacker
b931182b5b ref-manual: remove checkpkg task
It doesn't exist any more and its functionality is now taken care
of by "devtool check-upgrade-status"

(From yocto-docs rev: 9c155e91dc57cb49b97805805e802330188a2c04)

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-09-18 13:03:45 +01:00
Michael Opdenacker
d6966a39f2 ref-manual: document UPSTREAM_CHECK_COMMITS and UPSTREAM_VERSION_UNKNOWN
(From yocto-docs rev: 99b5fee6295a5c424fdb2cc0b34a4a486d7bf721)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-09-18 13:03:45 +01:00
Michael Opdenacker
95866fd533 manuals: delete unmaintained history sections
This deletes the history sections in each sub-manual,
which didn't add any value, given that they didn't list
the changes from one Yocto Project version to the next.

(From yocto-docs rev: 29ce5b89c438079793cc6457401b6a9275db877a)

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-09-18 13:03:45 +01:00
Michael Opdenacker
138219ce3b manuals: replace Freenode by Libera Chat as IRC host
Fixes [YOCTO #14546]
This also replaces the "#poky" channel (inactive)
by "#oe", which is more actively used.

(From yocto-docs rev: 46f98fe4f502aac8b16ba785490e9cf46364e4ec)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-09-18 13:03:45 +01:00
Tom Rini
3537849112 common-tasks: Add an example of using bbappends to add a file
Use the xserver-xf86-config_%.bbappend from meta-raspberrypi to provide
an example of having a bbappend file add files to an existing recipe.

(From yocto-docs rev: f510e748ff3bcbea6e34a7f225e05628303fdd12)

Signed-off-by: Tom Rini <trini@konsulko.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-09-18 13:03:45 +01:00
Vyacheslav Yurkov
62b13474bf ref-manual: add overlayfs class
(From yocto-docs rev: 5bd2f3c0bbf4178e381aec2b7de57ef8289c2271)

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-09-18 13:03:45 +01:00
Robert P. J. Day
70059b37c7 ref-manual: couple minor tweaks to Chapter 1
(From yocto-docs rev: d00282396ddc558bf025a81edc1dad53a814e13a)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
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-09-18 13:03:45 +01:00
Robert P. J. Day
2e09b9d8a3 ref-manual: add potential of parallelism to defn of "Task"
(From yocto-docs rev: 2e80de272b987c70374a1758e71c5c1371054d1f)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Quentin Schulz <foss@0leil.ṅet>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-09-18 13:03:45 +01:00
Robert P. J. Day
a98e336d7d ref-manual: correct typo in "classes" section, "${BPN}/{PV}"
(From yocto-docs rev: 28a72c5a1cc873b455d7854065e1f999e6c5b7a5)

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-09-18 13:03:45 +01:00
Robert P. J. Day
b16279603f ref-manual: remove mention of obsolete devtool "--any-recipe" option
Running "devtool edit-recipe -h" produces, in part, the output:

  --any-recipe, -a  Does nothing (exists for backwards-compatibility)

so it seems of little value to continue referring to it.

(From yocto-docs rev: fdac1da045e60d37025f754c9b6be5bb36f31c86)

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-09-18 13:03:44 +01:00
Robert P. J. Day
edaaa63664 ref-manual: render options in monospace to show quotes properly
It's important (at least for now) to mark up options with monospaced
font to highlight the difference between single and double quotes.

(From yocto-docs rev: 8d71ffdd3f354747dcade6de512355e8fa567728)

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-09-18 13:03:44 +01:00
Jon Mason
c1db4933ce dev-manual: update mailing list address
(From yocto-docs rev: 68e6782c19e9f88c3cd89b4948d22d216e0165b1)

Signed-off-by: Jon Mason <jdmason@kudzu.us>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-09-17 07:30:10 +01:00
Robert P. J. Day
98dcd17a5c README: update manual list and names, online docs URL
Minor tweaks to top-level README:
  - add missing line for overview manual
  - correct manual names to match their *actual* names
  - point reader at docs.yoctoproject.org for online docs

(From yocto-docs rev: 0ce9097728dbdca926fdf7065490207d09a34cb0)

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-09-04 08:46:35 +01:00
Robert P. J. Day
a24f1db1b3 ref-manual: update SYSROOT_DIRS_* variable entries
Both SYSROOT_DIRS and SYSROOT_DIRS_BLACKLIST have more current
values.

(From yocto-docs rev: 750ae3fca42e273cd533f9c8b678c2e144164191)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-09-04 08:46:35 +01:00
Robert P. J. Day
5cffbbb99a dev-manual: drop "three" since there are four requirements
Since there are actually four listed requirements, just drop the
number to avoid future issues.

(From yocto-docs rev: 612015dc227600d23956402eab7f324e0c8fd42a)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-09-04 08:46:35 +01:00
Robert P. J. Day
81592ed6ac dev-manual: various pedantic nitpickery
Some minor grammatical and structure tweaks.

(From yocto-docs rev: 505f9b21898475746d401c8ab79b95f3dc4d02e7)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-09-04 08:46:35 +01:00
Robert P. J. Day
4a979c6f1c dev-manual: small number of minor aesthetic tweaks
Just a collection of:

  - grammar tweaks
  - space fixes
  - font changes

(From yocto-docs rev: c49984f89cd2295c54f01730649aaca83eaf515e)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-09-04 08:46:35 +01:00
Robert P. J. Day
055b36a005 ref-manual: add missing "${PN}-src" to default PACKAGES list
(From yocto-docs rev: c4e986364fc67799a9cba8fa1e9d33481bebaa8c)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
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-09-04 08:46:35 +01:00
Michael Opdenacker
0e95c887da dev-manual: explicit that devpyshell is a task
Without this, readers could think that "devpyshell" is a script,
at least until they read the remainder of the section.

(From yocto-docs rev: fe1e3323a633acf51d64cfb6c4bdd2ecd324a79e)

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-09-04 08:46:35 +01:00
Robert P. J. Day
5a9c5c47e0 dev-manual: pass False to d.getVar() for devpyshell example
In the example in section 3.9, the call to d.getVar() needs to have
the additional argument of "False" so that the output is not expanded.

(From yocto-docs rev: ae364e76a322278e7fe37aeecaa5e854d0a0efee)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Tested-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-09-04 08:46:35 +01:00
Ross Burton
89efc52045 dev-manual/common-tasks: sync libxpm fragment with the recipe
Specifically, the actual recipe now has LICENSE=MIT.

(From yocto-docs rev: 9f64931308f73607c40ed1eb8cf915666b6ff90a)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-09-03 14:31:00 +01:00
Richard Purdie
3fd2dff4eb ref-manual: Fix reference to bbappend section of dev-manual
(From yocto-docs rev: 015914cdbe3f58a39ec64ee6a4181d3d29741205)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-08-20 08:53:03 +01:00
Richard Purdie
f036aeac2a bsp-guide: Fix reference to bbappend section of dev-manual
This was broken in a previous commit which broke doc generation.

(From yocto-docs rev: 8fc45b2e7e2cd1a18d65014f88d83631cc67c2fb)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-08-20 08:53:03 +01:00
Jon Mason
319a4bb1d0 docs: update docs with new tune locations
(From yocto-docs rev: ce6d3dbaea9d6250567d23e7d95ce9cbd3a03c99)

Signed-off-by: Jon Mason <jdmason@kudzu.us>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-08-18 17:01:58 +01:00
Olaf Mandel
0b8f844c8c kickstart: document which options accept units
Document which units are accepted as parameters for the four options
that accept units. Also be pedantic about using binary instead of
decimal prefixes so readers don't have to wonder.

(From yocto-docs rev: 6b1d7d102ed3b509dfb3e43a3d7a27226f504df5)

Signed-off-by: Olaf Mandel <o.mandel@menlosystems.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-08-14 12:04:24 +01:00
Tom Rini
2eb5550db4 manuals: Rename the "Using .bbappend Files in Your Layer" section
To prepare to add another example bbappend, rename the current "Using
.bbappend Files in Your Layer" section to "Appending Other Layers Metadata
With Your Layer". Name the current example as "Overlaying a File Using
Your Layer".

(From yocto-docs rev: 62d7b5721b2fbcf1e22fc4e7bbac51d52260730e)

Signed-off-by: Tom Rini <trini@konsulko.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-08-14 12:04:24 +01:00
Tom Rini
98ca1114ef common-tasks: Add a summary to the end of the bbappend example
Try and make it clearer what the final result of this bbappend example
is.

(From yocto-docs rev: c6d0b030fe495a9eb81ad542ad56479f7e7e18e2)

Signed-off-by: Tom Rini <trini@konsulko.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-08-14 12:04:24 +01:00
Daniel Gomez
cb8c550da4 docs: fix typo in releases
Fix dunfell typo for releases 3.1.9 and 3.1.10.

(From yocto-docs rev: aae1f5c1a4a0e1d56cfea66d06dbf8edbc084b8d)

Signed-off-by: Daniel Gomez <daniel@qtec.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-08-14 12:04:24 +01:00
Michael Opdenacker
0cf790a0fe dev-manual: fix grammar in post-install script explanations
(From yocto-docs rev: bc0fa4d432c3a9aeccc5758c7ca793cae4f4852b)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-08-14 12:04:24 +01:00
Michael Opdenacker
350197e46a Manuals: replace "file name" by "filename"
There are many more instances of "filename" or "filenames" than
of "file name" or "file names".

The winner takes it all!

(From yocto-docs rev: 13ef92bc301166c2e21d2603b2501749248dbe91)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-08-14 12:04:24 +01:00
Michael Opdenacker
b5f203516b sdk-manual: reference obsolete reference to ADT
(From yocto-docs rev: 024258ecd3c50184ab38d54e7bec2698c04fc631)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-08-14 12:04:23 +01:00
Quentin Schulz
52db0c7575 docs: overview-manual: concepts: remove long-gone BBHASHDEPS variable
BBHASHDEPS was removed from bitbake in April 2014, with the following
commit:
92526eadd09d "bitbake-worker: Drop BBHASH variables"

so let's remove mentions from the docs.

(From yocto-docs rev: f9e1768b8c85e3ad7fa974940a90996a5ffee3f5)

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-08-14 12:04:23 +01:00
Quentin Schulz
3d93ddf9e8 docs: fix new override syntax migration
Fix bits missed by the migration script.

(From yocto-docs rev: 452e0c5067476fd2ce81f09e6c73da84ced4bbd0)

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-08-14 12:04:23 +01:00
Michael Opdenacker
ed6482821c test-manual: overrides syntax updates
Updated with openembedded-core/scripts/contrib/convert-overrides.py

(From yocto-docs rev: 4bb16d0d1a0b8a42f20f39d79c642d612074565a)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-08-14 12:04:23 +01:00
Michael Opdenacker
134da15e22 sdk-manual: overrides syntax updates
Updated with openembedded-core/scripts/contrib/convert-overrides.py

(From yocto-docs rev: 39cf6b2eb063815a3e2bf7a71ffd1fd6351cc594)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-08-14 12:04:23 +01:00
Michael Opdenacker
956056e647 ref-manual: overrides syntax updates
Updated with openembedded-core/scripts/contrib/convert-overrides.py

(From yocto-docs rev: 23ee6fbdf429d4cf1de4129e92dc7de4e6e9d184)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-08-14 12:04:23 +01:00
Michael Opdenacker
80859f21b5 kernel-dev manual: overrides syntax updates
Updated with openembedded-core/scripts/contrib/convert-overrides.py

(From yocto-docs rev: d4598b592d1b0c9ce9448a8858eb4f47d83487b2)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-08-14 12:04:23 +01:00
Michael Opdenacker
ded502d2a7 dev-manual: overrides syntax updates
Updated with openembedded-core/scripts/contrib/convert-overrides.py

(From yocto-docs rev: 105c4af0f2d78f27639f4f4d8ee4be65fcbfda52)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-08-14 12:04:23 +01:00
Michael Opdenacker
4f2356a081 bsp-guide: overrides syntax updates
Updated with openembedded-core/scripts/contrib/convert-overrides.py

(From yocto-docs rev: 664890810e8dcdaf3dd4467ef8f9a99f72ce6dce)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-08-14 12:04:23 +01:00
Michael Halstead
77ce05bd36 releases: update to include 3.1.10
Adding 3.1.10 to documentation switcher and release list.

(From yocto-docs rev: 86b44b72c366f56d6977e7462aca8821721d89bd)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-08-11 20:41:54 +01:00
Michael Opdenacker
4c7e3b64bc manuals: further documentation for cve-check
This adds details about the actual implementation
of vulnerability checks, about how to fix or ignore
vulnerabilities in recipes, and documents the
CVE_CHECK_PN_WHITELIST and CVE_CHECK_WHITELIST variables.

(From yocto-docs rev: 55886d211218b3a604c2f8a29c854685ebf284dd)

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-08-10 11:29:46 +01:00
Michael Opdenacker
23e640b809 manuals: mention license information in footer
Previously, the license for the manuals was only
stated in the SPDX headers at the beginning of source files

(From yocto-docs rev: cef60f23d5601a18d7ba7e894af2aa459fb2efb8)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-08-10 11:29:46 +01:00
Richard Purdie
eb047a25bb migration-3.4: Add extra notes to override syntax changes
(From yocto-docs rev: dba53562b684c511fb59a3272656cb6052f28fb2)

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>
2021-08-10 11:29:46 +01:00
Richard Purdie
ae6153e10b test-manual: Add extra detail to YP Compatible section
Add a note about documenting where a layer doesn't support 'core'
functionality.

(From yocto-docs rev: 0fc15d069aae11e6e705d80f684345150ff7bf3b)

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>
2021-08-10 11:29:46 +01:00
Michael Halstead
f64b796093 releases: update to include 3.3.1
Adding 3.3.1 to documentation switcher and release list.

(From yocto-docs rev: 3c98afb0fefd889e8036639d9a2c775b73b237c2)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-08-04 11:20:48 +01:00
Michael Opdenacker
355171f4e3 profile-manual: document how to build perf manpages on target
Thanks to closing yocto bug #3388, there is now a simple way
to build the perf manpages for use on the target

(From yocto-docs rev: 12dd3ecb054c1668cdccc220ca21b88635531784)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-08-02 17:46:39 +01:00
Michael Opdenacker
9ca793696a ref-manual: remove example recipe source files
These files are not used to build to documentation
and were updated and moved to the "meta-skeleton" layer
(except "mtd-makefile" which is broken and no longer
worth maintaining there, as a recipe for more recent
versions of "mtd-utils" exists).

(From yocto-docs rev: 5fc765fc22e2fa3124089f609db2e60113606c81)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-08-02 17:46:39 +01:00
Michael Opdenacker
76053e0f78 manuals: initial documentation for CVE management
This starts to document vulnerability management
and the use of the CVE_PRODUCT variable

(From yocto-docs rev: 2b9199fe490cb3ec126bffc6518646194a94ace4)

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-08-02 17:46:39 +01:00
Stefan Wiehler
090384d9e7 dev-manual: fix source release example script
(From yocto-docs rev: 6c939a3bbc9116d32c73df58f60ceb4809328eb3)

Signed-off-by: Stefan Wiehler <stefan.wiehler@missinglinkelectronics.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-08-02 17:46:39 +01:00
Richard Purdie
f735627e7c common-tasks: Fix conversion error in npm example
(From yocto-docs rev: a6441aa5765be4a121a45ede94ca6d4c6fedf4ef)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-07-30 22:52:19 +01:00
Michael Opdenacker
d664794cce manuals: remove explicit BitBake variable references
The standard :term:`VARIABLE` will refer to the
description of the variable in the YP variable index. If it
doesn't exist, it will refer to the description of the variable
in the BitBake manual.

(From yocto-docs rev: 34cb466caf872f9284eb81f6a5f31ad606214dee)

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-07-30 22:49:15 +01:00
Michael Opdenacker
38496093d7 manuals: simplify references to BitBake manual
Replacing ":ref:`section name<bitbake:bitbake-user-manual/bitbake-user-manual-<section>:section name>`"
by ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-<section>:section name`"
when the reference description is the same as the section name.
In this case, that's unnecessary to repeat the section name in the description part.

(From yocto-docs rev: 6a1a590f9ef77dc8842ea5945661135992eb94e1)

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-07-30 22:49:15 +01:00
Michael Opdenacker
1452ac11ee documentation/README: improve BitBake manual referencing guidelines
Removing the ":ref:`-D <bitbake:..." syntax as it's not necessary
Adding more and simpler ways of making references to the BitBake
manual.

(From yocto-docs rev: 7ad087a81e5dca7088c8088cd0cdcf31606baa6e)

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-07-30 22:49:15 +01:00
Richard Purdie
0d527052cb migration-guides: Add start of 3.4 guide with override migration notes
(From yocto-docs rev: e60019c81e63250feaee4937873a90042074030b)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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-07-30 22:49:15 +01:00
Michael Opdenacker
eb31b774b1 dev-manual: fix wrong reference to class
The file 'meta/classes/core-image.bbclass' seems have nothing about
the 'IMAGE_FEATURES' variable, using 'meta/classes/image.bbclass' instead.

(From yocto-docs rev: b0eb9ef09c73db97e3f289565d0ce17d9aa7e8cd)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Mingrui Ren <jiladahe1997@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-07-30 22:49:15 +01:00
Michael Opdenacker
1b52175f6b quick start manual: update "source oe-init-build-env" output
(From yocto-docs rev: 0c8be05b393ea318d033af6b596da5349c75653a)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-07-30 22:49:15 +01:00
Michael Opdenacker
708aacbb0b test-manual: document LTO related reproducibility bug
(From yocto-docs rev: 33b6f7cec780f77ed9cd0518f72ec8c0e3c08e68)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Tony Battersby <tonyb@cybernetics.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-07-30 22:49:15 +01:00
Joshua Watt
84fbf8632d ref-manual: Document BUILDHISTORY_PATH_PREFIX_STRIP
(From yocto-docs rev: c834fab46794233864e6bcb587ab75f2bfa1631c)

Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-07-16 21:59:31 +01:00
Quentin Schulz
5a6fb291ad docs: replace remaining `FOO by :term:FOO`
A few occurences appeared between the time the original patch was sent
and it was applied, this fixes it.

Also, the original patch didn't take into account lowercase terms, this
is now fixed, see module_autoload for example.

Finally, as is often the case with regexp, there was a typo in it that
didn't make it match as much as it should have.

The script that is used to do the replacement of ``FOO`` by :term:`FOO`
is the following Python code:

import re
from pathlib import Path
from runpy import run_module
import contextlib
import io
import sys

re_term = re.compile(r'variables.html#term-([a-zA-Z_0-9]*)')
terms = []
new_terms = set()

with contextlib.redirect_stdout(io.StringIO()) as f:
    run_module('sphinx.ext.intersphinx', run_name='__main__')

objects = f.getvalue()

match = re_term.search(objects)
while match:
    if match.group(1):
        terms.append(match.group(1))
    match = re_term.search(objects, match.end())

for rst in Path('.').rglob('*.rst'):
    with open(rst, 'r') as f:
        content = "".join(f.readlines())
    for term in terms:
        content = re.sub(r'``({})``(?!.*\s+[~=-]{{{:d},}})'.format(term, len(term)), r':term:`\1`', content)

    with open(rst, 'w') as f:
        f.write(content)

This script takes one argument as input: an objects.inv. Bitbake's can
be gotten from https://docs.yoctoproject.org/bitbake/objects.inv. The
objetcs.inv from the current git repo can be gotten from
documentation/_build/html/objetcs.inv after running `make html`.

Note that this excludes from replacement terms that appear in section
titles as it requires refs to be changed too. This can be automated too
if need be but right now it looks a bit confusing to have an anchor link
(for sections) also have a term/reference link in it. I am not sure this
is desired today.

This is the result of two runs of the aforementioned script, once with
Bitbake objects.inv and once with this repo's.

Fixes: ba49d9babfcb "docs: replace ``FOO`` by :term:`FOO` where possible"

(From yocto-docs rev: 1e1b0c4dd241b6657035172b1f7b5f341afa8b25)

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-07-16 21:59:31 +01:00
Patrick Williams
aa26842ec3 docs: remove image-mklibs references
The image-mklibs bbclass was removed from OE-Core with
commit 908df863b419d1cad7317153101fc827e7e3a354 and
corresponding changes to local.conf.sample were made
in meta-yocto with c8c8f284eb2abe7e1352850a885454487cc01986.

Remove all references to image-mklibs from the documentation
as it is no longer supported.

(From yocto-docs rev: f45b378eb2cb08c173620cffb17cbcc8b402da0d)

Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-07-10 23:39:18 +01:00
Michael Halstead
bc164bd86a releases: update to include 3.1.9
Adding 3.1.9 to documentation switcher and release list.

(From yocto-docs rev: 6951b86a2e0e95bb72db12624efa23fec579bc70)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-07-02 07:24:21 +01:00
Michael Opdenacker
f585bf4c95 sdk-manual: add missing index references
(From yocto-docs rev: 3308b9bebce69cda1b2e0bd69f59b304ea1e367f)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-06-19 16:54:02 +01:00
Michael Opdenacker
4be12b97dc sdk-manual: fix wrong word
(From yocto-docs rev: 93c43a019e3f44b0eb83a16e44372d98b5dce1a9)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-06-19 16:54:01 +01:00
Michael Opdenacker
10e0ee9041 sdk-manual: add missing quoting around "devtool upgrade"
(From yocto-docs rev: 8863967d1e4e4a5b8014bf55302752419352c25d)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-06-19 16:54:01 +01:00
Michael Opdenacker
b394cca927 manuals: fix issues related to trailing dots
Fix missing reference and styling issues found thanks
to trailing dots (only non black character in a line)

Matches (and multiple false positives) found with the below command:
git grep "\s\.$"

(From yocto-docs rev: 1d3026f50753d9ccf39b7d0163c77c765d754994)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-06-19 16:54:01 +01:00
Michael Opdenacker
e0ab2c01d6 migration guides: remove index reference to BB_SETSCENE_VERIFY_FUNCTION2
This variable is no longer documented in Bitbake's manual
as it's not in use any more.

(From yocto-docs rev: 68328d93023d2e3251a05ea2830c4f6b6de65708)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-06-19 16:54:01 +01:00
Quentin Schulz
7d3f57cfd2 docs: replace `FOO by :term:FOO` where possible
If a variable has a glossary entry and some rST files write about those
variables, it's better to point to the glossary entry instead of just
highlighting it by surrounding it with two tick quotes.

This was automated by the following python script:
"""
import re
from pathlib import Path

with open('objects.inv.txt', 'r') as f:
    objects = f.readlines()

with open('bitbake-objects.inv.txt', 'r') as f:
    objects = objects + f.readlines()

re_term = re.compile(r'variables.html#term-([A-Z_0-9]*)')
terms = []

for obj in objects:
    match = re_term.search(obj)
    if match and match.group(1):
        terms.append(match.group(1))

for rst in Path('.').rglob('*.rst'):
    with open(rst, 'r') as f:
        content = "".joing(f.readlines())
    for term in terms:
        content = re.sub(r'``({})``(?!.*\s*[~-]+)'.format(term), r':term:`\1`', content)

    with open(rst, 'w') as f:
        f.write(content)
"""

(From yocto-docs rev: ba49d9babfcb84bc5c26a68c8c3880a1d9c236d3)

Signed-off-by: Quentin Schulz <foss@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-06-19 16:54:01 +01:00
Michael Opdenacker
7a9b74e9d2 sdk-manual: fix broken references
Detected by running:
git grep "^[\ ]*\" section" | grep -v "\`"

(From yocto-docs rev: 1e4909304a7e04fa707633b58c5e0d68a67d353a)

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-06-19 16:54:01 +01:00
Richard Purdie
ff6b8af378 README: Tweak as the website isn't really new now
(From yocto-docs rev: 78c50ffffb6f4dd38b5097a64c2e284a6177750a)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-06-16 16:33:18 +01:00
Michael Opdenacker
682ddc5f2a releases: put release number after "Release Series"
This avoids a confusion because of the way other manuals
are numbered, and aligns with the way the migration guides
are listed.

(From yocto-docs rev: 92f17a0ac68a64c86fa46ffbcec7acb3de3b23bf)

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>
2021-06-14 22:45:33 +01:00
Michael Opdenacker
c62b924e29 releases: clarify supported and outdated releases
(From yocto-docs rev: c3d6c36497f7af1ca19357c5474ff1e5743f597b)

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>
2021-06-14 22:45:33 +01:00
Daniel Wagenknecht
54d16ea967 ref-manual: variables: fixup class reference in IMAGE_MANIFEST
The definition of IMAGE_MANIFEST was moved to a different class. Fixup
the documentation to reflect this change.

(From yocto-docs rev: 15c0a09154de2a1f6d36e1bb5bf283bd08c9ec3d)

Signed-off-by: Daniel Wagenknecht <dwagenknecht@emlix.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-06-14 22:45:33 +01:00
Daniel Wagenknecht
6bf4cd4e8d ref-manual: variables: fixup example in IMAGE_CMD
The example for IMAGE_CMD_jffs2 given in the glossary for IMAGE_CMD
didn't align with the implementation anymore. Update it to match the
implementation.

(From yocto-docs rev: 4db4efc42af89a109313c4cf33ae13e8236215e9)

Signed-off-by: Daniel Wagenknecht <dwagenknecht@emlix.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-06-14 22:45:33 +01:00
Richard Purdie
eab093768d test-manual: Add initial YP Compatible documentation
This starts documenting the Yocto Project Compatible badging programme. This
adds an initial piece of documentation about it from which we can improve
as needed.

(From yocto-docs rev: baa70e3d0d6100e091eb78cf465a9734068a44e7)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-06-14 22:45:33 +01:00
Daniel Wagenknecht
bec73cd4e6 ref-manual: migration-2.2: add note about IMGDEPLOYDIR
(From yocto-docs rev: e9921b746a0b2a4a2192bab224d9afa9d9395e1e)

Signed-off-by: Daniel Wagenknecht <dwagenknecht@emlix.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-06-14 22:45:33 +01:00
Daniel Wagenknecht
2618389ddc ref-manual: variables: document IMGDEPLOYDIR
DEPLOY_DIR_IMAGE has been replaced by IMGDEPLOYDIR for most use cases
since OE-Core rev 6d969bacc718e21a5246d4da9bf9639dcae29b02. Document
IMGDEPLOYDIR and add a note to DEPLOY_DIR_IMAGE about it.

(From yocto-docs rev: dad7046f9428bde476d2241209c118d52529bed5)

Signed-off-by: Daniel Wagenknecht <dwagenknecht@emlix.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-06-14 22:45:33 +01:00
Daniel Wagenknecht
f5e157d229 ref-manual: variables: update examples refering to DEPLOY_DIR_IMAGE
DEPLOY_DIR_IMAGE has been replaced by IMGDEPLOYDIR for most use cases
since OE-Core rev 6d969bacc718e21a5246d4da9bf9639dcae29b02. Update
examples given in the documentation to use IMGDEPLOYDIR and match their
implementation.

(From yocto-docs rev: 6cad5984306ffbf748a888cedc1a5015105e89fa)

Signed-off-by: Daniel Wagenknecht <dwagenknecht@emlix.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-06-14 22:45:33 +01:00
Michael Opdenacker
5f978a6cca ref-manual: move migration guides to separate document
This makes the reference manual much lighter by moving
the migration guides to a separate document.

The migration guides are also reordered from last to first,
and they appear directly in the left bar, making them easier
to find in the documentation.

(From yocto-docs rev: 5121b86ee97eb62a0c69c9ad1fc0e3fabbe3e934)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-06-14 22:45:33 +01:00
Michael Opdenacker
dae1e986a0 manuals: fix epub export warnings
Needed now that warnings are turned into errors

(From yocto-docs rev: 3f99cff8c6c672967eb09f6950d16ed30260ca68)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-06-14 22:45:33 +01:00
Quentin Schulz
c2a68819d0 documentation: Makefile: turn warnings into errors by default
-W is for turning warnings into errors, --keep-going to make sure the
whole documentation is built and all warnings will be printed before
failing.

Since there's currently no warning, it's time to introduce it!

(From yocto-docs rev: 5d7b8547549b2203a03df617cdba70ccf2194c62)

Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-06-14 22:45:33 +01:00
Richard Purdie
1a1941cc48 test-manual: add initial reproducible builds documentation
(From yocto-docs rev: a4ec469042ccb2487c1d076a2c005f33f8021816)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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-06-14 22:45:33 +01:00
Ross Burton
ae7595a603 Remove Clutter references
The clutter class and image have been moved to meta-gnome before it
is finally obsoleted for good, so remove mentions from the documentation.

(From yocto-docs rev: adab5d0047354b5a1b11c2ece48abd8f295f69b0)

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>
2021-06-05 09:38:27 +01:00
Quentin Schulz
ef13ab1c22 docs: ref-manual: variables: add missing links to terms glossary
The automated script used back then didn't take into account that
terms could be lowercase which is the case for module_autoload and
module_conf, so let's add a link to those too.

Fixes: 9e468274eaad "docs: ref-manual: ref-variables: add links to terms in glossary"

(From yocto-docs rev: beeaf0c48dcd79626c1591a68da4b13387aa0c3f)

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-06-05 09:38:27 +01:00
Quentin Schulz
67d8de7df4 docs: ref-manual: migration-3.0: remove reference to non-existing BB_SETSCENE_VERIFY_FUNCTION2
This variable has been removed in July 2019 with commit
5deaa5df730a "runqueue: Drop unused BB_SETSCENE_VERIFY_FUNCTION2" in
bitbake git repo.

The glossary entry for the variable has been recently removed from bitbake
documentation, therefore the ref breaks the build.

Let's remove the reference so that the build still passes.

(From yocto-docs rev: 4db673a559d290547d4d6006ea692becb574deb7)

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-06-05 09:38:27 +01:00
Robert P. J. Day
c26ea554a7 ref-manual: add glossary entry for NON_MULTILIB_RECIPES
(From yocto-docs rev: 6ed8e747265df899d8ce464d83281b0e0f04f9b2)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-06-02 23:32:34 +01:00
Nicolas Dechesne
e736434156 index: split releases manuals and indexes into two sections in the tree
(From yocto-docs rev: f245b7b096f699cdc4426022d61d963d7deb9a92)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Tested-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-06-02 23:32:34 +01:00
Nicolas Dechesne
7c99358a1a index: remove links to releases manual and index
Keep the links in the left side navigation bar, but remove them from
the main page.

(From yocto-docs rev: d01324cfb6ecada22005ca05db99b0c1f75eb22e)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Tested-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-06-02 23:32:34 +01:00
Nicolas Dechesne
4f13203488 index: remove the link/section to 'mega manual' from main page
The 'megamanuel' can be selected using the drop down menu on the
documentation website. It was reported it is confusing to have it on
the main page (and in the left side bar) as well. Let's remove it.

(From yocto-docs rev: 593898dc4a4695395856ea481b58cc5092ed3263)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Tested-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-06-02 23:32:34 +01:00
Richard Weinberger
b755468a74 Document erofs filesystem targets
(From yocto-docs rev: 94cbbec788660cc3b18232e2343ce6723942426c)

Signed-off-by: Richard Weinberger <richard@nod.at>
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-06-02 23:32:34 +01:00
Robert P. J. Day
23ff556abe ref-manual: add SRCTREECOVEREDTASKS to variable glossary
(From yocto-docs rev: c3e8eb234c9d1cf67dc46666ea26c1e4eb945c2c)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-06-02 23:32:34 +01:00
Michael Halstead
b5d761583e releases: update to include 3.1.8
Adding 3.1.8 to documentation switcher and release list.

(From yocto-docs rev: 657408bf30279b44f1e1255787a2c56b739df142)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-06-02 23:32:34 +01:00
Michael Halstead
c23a25e607 releases: update to include 3.3.1
Adding 3.3.1 to documentation switcher and release list.

(From yocto-docs rev: db80bb70d9bea7008cb6b2795c8f617b1486ca03)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-05-25 22:26:34 +01:00
Robert P. J. Day
0411a1e027 ref-manual: add links to some variables in glossary
Add some links to a small set of glossary variables that I happened
to be perusing at the time.

(From yocto-docs rev: d71d8da78285f2314bfd27a821b26434e39622a8)

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-05-22 12:16:41 +01:00
Michael Opdenacker
5871eeea6e manuals: simplify style
(From yocto-docs rev: 3332ee547cde0f2f8718f83d526b21339b0a8901)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-05-22 12:16:41 +01:00
Michael Opdenacker
31f1d4d331 overview-manual: simplify style and add missings references
(From yocto-docs rev: 4a07947dbe0dd70fd1d528a207d663dfdca2b7c1)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-05-22 12:16:41 +01:00
Michael Opdenacker
42f6423cc8 sdk-manual: simplify style and fix formating
(From yocto-docs rev: fffd2ce4c9efbdeb75b7afd6f4f2ce4ffca517ad)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-05-22 12:16:41 +01:00
Michael Opdenacker
5386f28c44 dev-manual: simplify style
(From yocto-docs rev: a8b3c1a5cbfa7fb0bca0d7dd8f38ac59acf032fa)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-05-22 12:16:41 +01:00
Michael Opdenacker
020562cfbc kernel-dev manual: simplify style
(From yocto-docs rev: 5bbbed35175ffcabb24bcac305d17563b8d9b9e3)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-05-22 12:16:40 +01:00
Michael Opdenacker
4db4e4ca46 ref-manual: simplify style
(From yocto-docs rev: 657a7f54856afd6fec7f2cb0b5f12b4b2d24adb7)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-05-22 12:16:40 +01:00
Armin Kuster
68ee5b4bcc poky.yaml: fedora33: add missing pkgs
[ Yocto #14188]

The following packages where needed to a fresh FC33 install
perl-FindBin
perl-File-Compare
perl-File-Copy
perl-locale

Error seen:

openssl-native-1.1.1g-r0 do_configure: Execution of '/{snipped}/build/tmp-glibc/work/x86_64-linux/openssl-native/1.1.1g-r0/temp/run.do_configure.14627' failed with exit code 2:
Can't locate FindBin.pm in @INC (you may need to install the FindBin module)

(From yocto-docs rev: 5b4127dd72a465ff8c962c425e78140ca8e536db)

Signed-off-by: Armin Kuster <akuster808@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-05-22 12:16:40 +01:00
Ross Burton
c17083af21 ref-manual: Ubuntu 20.04 is also LTS
(From yocto-docs rev: e7b7ec18c27b34e96de9b576b8bfe518f7466bff)

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>
2021-05-22 12:16:40 +01:00
Michael Halstead
ed2d99203d releases: update to include 3.2.4
Adding 3.2.4 to documentation switcher and release list.

(From yocto-docs rev: b24cddff0f1367360441e3f9ff59cbed77da28ad)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-05-18 12:53:08 +01:00
Michael Opdenacker
d4a82b30b7 manuals: reduce verbosity related to "the following" expression
(From yocto-docs rev: da9d1cfb5c084d172eff3cb10ec3631dd8266260)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-05-13 11:28:34 +01:00
Michael Opdenacker
f3540fc691 manuals: reduce verbosity with "worry about" expression
(From yocto-docs rev: 6c65f5f350cdc79a435deb20c48d861d9f4c5c14)

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-05-13 11:28:34 +01:00
Daniel Wagenknecht
e145129aaa kernel-dev: document KCONFIG_MODE
(From yocto-docs rev: 12aa6f9c6af68ea03fbb056677213b00d693cf5f)

Signed-off-by: Daniel Wagenknecht <dwagenknecht@emlix.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-05-13 11:28:34 +01:00
Robert P. J. Day
0fc54213c2 ref-manual: delete extraneous back quote
(From yocto-docs rev: 784d39fe28436302b4df7e1ea08582d4d2f664c6)

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-05-13 11:28:34 +01:00
Robert P. J. Day
6afc2f5737 ref-manual: delete references to dead LSB compliance
Since LSB does not seem to be relevant these days, delete mentions of
it.

(From yocto-docs rev: 5b4354e0611253b40ad58613b910b6591493a1b4)

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-05-13 11:28:34 +01:00
Drew Moseley
6591d95eb1 manuals: fix a few incorrect option specifications.
(From yocto-docs rev: b6b218de3629d1f8fb61137e8bdcf84739cfaf67)

Signed-off-by: Drew Moseley <drew@moseleynet.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-05-13 11:28:34 +01:00
Robert P. J. Day
f3a66b53bb sdk-manual: various cleanups to intro.rst
Minutiae including grammar fixes, increased brevity and adding a
proper link to another SDK manual section.

(From yocto-docs rev: 21d6c6fcbae938c256da6e72d6ac8d2ca72d5bc0)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
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-05-13 11:28:34 +01:00
Robert P. J. Day
60c081d9f8 sdk-manual: couple minor fixes in using.rst
One grammar fix, and adding two proper links to other sections.

(From yocto-docs rev: 969d4737da992e1fbca14cfbeb35bd5401698cba)

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-05-13 11:28:34 +01:00
Robert P. J. Day
68e84ae936 sdk-manual: fix broken formatting of sample command
And add proper quoting around the first instance
of the "image" word, as it refers to a keyword in the
subsequent command.

(From yocto-docs rev: 1ffaa1db5a6eba53558b714f6071ea2e9bfe03e6)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-05-03 13:37:48 +01:00
Michael Opdenacker
c075e28aa0 dev-manual: update references to Docker installation instructions
Update Docker installation URL on various plaforms, replacing
some URLs by the ones they now redirect to, renaming "Docker CE"
to "Docker Desktop" on Mac and Windows, and to "Docker Engine"
on GNU/Linux.

Stop mentioning "Docker Toolbox" which is now deprecated and
replaced by "Docker Desktop" on Mac and Windows.

(From yocto-docs rev: 8eb249aed50b7b5b2078648c9efd9c79262ae57f)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-05-03 13:37:48 +01:00
Robert P. J. Day
73d317c393 sdk-manual: "beablebone" -> "beaglebone"
(From yocto-docs rev: 29d8b6f07dddba43cf14706ec26cc8cf033d1040)

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-05-03 13:37:48 +01:00
Alexander Kanavin
e1ebdcff7c dev-manual/common-tasks.rst: correct the documentation for debuginfod
Particularly,
- correctly describe the use of DEBUGINFOD_URLS; drop it from bitbake variables
- all necessary component tweaks are enabled by default via DISTRO_FEATURES
- provide on-target examples of what to look for when things work properly

(From yocto-docs rev: 6d5d568d427b22675b999f94ead829ab1bef0b21)

Signed-off-by: Alexander Kanavin <alex.kanavin@gmail.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-05-03 13:37:48 +01:00
Trevor Gamblin
4aff77c851 ref-manual/variables.rst: Add incompatibility warning for SERIAL_CONSOLES_CHECK
See [YOCTO #13921]

Add details to the SERIAL_CONSOLES_CHECK entry to clarify that it
doesn't work with read-only rootfs.

(From yocto-docs rev: cefd66301a40f9048499879674e467543f704c44)

Signed-off-by: Trevor Gamblin <trevor.gamblin@windriver.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-23 16:39:03 +01:00
Michael Opdenacker
c3c6de2187 manuals: code insertion simplification over two lines
This simplifies paragraphs ending with a colon and followed
by code insertion.

Automatically substituted through the command:
sed -i -z "s/:\n\s*::/::/g" file.rst

This generates identical HTML output.

(From yocto-docs rev: 28e2192a7c12d64b68061138a9f6c796453eebb1)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-23 16:39:03 +01:00
Michael Opdenacker
773536c333 manuals: simplify code insertion
This replaces instances of ": ::" by "::", which
generates identical HTML output

(From yocto-docs rev: 1f410dfc7c16c09af612de659f8574ef6cff4636)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-23 16:39:03 +01:00
Michael Opdenacker
21b42cc54f dev-manual: fix code insertion
Fix a misaligned code insertion statement, causing
the code block to be misaligned compared to the other ones
in subsequent paragraphs

(From yocto-docs rev: bc03d122a35ac027d0aab5bfd70b366933fd7356)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-23 16:39:03 +01:00
Vineela Tummalapalli
1ea11c5c20 Adding dunfell 3.1.7 to the switcher and release list.
(From yocto-docs rev: bed221137de77340280d71b4a8b0f2f60addc566)

Signed-off-by: Vineela Tummalapalli <vineela.tummalapalli@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-23 16:39:03 +01:00
Michael Halstead
6204a3f5f4 releases: update to include 3.3
Adding Hardknott to documentation switcher and release list.

(From yocto-docs rev: d1578f6ae84d0c44c63632bd5f3146653f1310a3)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-20 14:04:56 +01:00
Paul Eggleton
1203d1f24d ref-manual: add mention of DISTUTILS_SETUP_PATH
Add a variable glossary entry and corresponding 3.3 migration
section entry for DISTUTILS_SETUP_PATH.

(From yocto-docs rev: 0823237e6f4b9dbdf48500b3c1e8cc61696fa2d2)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-15 20:18:58 +01:00
Paul Eggleton
34a72cf613 ref-manual: migration guide: add release codenames
People will see release codenames in other contexts, and thus it is
useful to mention them explicitly here rather than having to go to the
Releases wiki page to map version number to release codename.

(From yocto-docs rev: fe3a91e8b3ef09b79711b62c6a08643f9444dcec)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-15 20:18:58 +01:00
Paul Eggleton
e88b0ba326 ref-manual: add migration section for 3.3 release
(From yocto-docs rev: b8b6e8335be382337fe4adda11d5a90872ff4c79)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-15 20:18:58 +01:00
Paul Eggleton
5b11fd8881 ref-manual: tweak buildtools section
Add a joining paragraph and fix the second section so that it makes
sense with the addition of the first one.

(From yocto-docs rev: 8ee993995d9d72873f36e40dda5e3f345901978c)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-15 20:18:58 +01:00
Paul Eggleton
93e2dd396e ref-manual: fix reference to build-essential
This has been here since the text was added to the DocBook version.

(From yocto-docs rev: 611588b065ab98d7021173525027d16b5ab519c8)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-15 20:18:58 +01:00
Paul Eggleton
4af4b69f71 ref-manual: add FIT_KERNEL_COMP_ALG*
Add FIT_KERNEL_COMP_ALG and FIT_KERNEL_COMP_ALG_EXTENSION. Examining
OE-Core commit 5c72105e2973e613b5c0f0e6310ffdea6e56c6c7 and the
associated code, these do not enable arbitrary selection of compression
algorithm - only disabling compression - so document them accordingly.

(From yocto-docs rev: 41640526dd87153fdf802b058336c6fb466b8ade)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-15 20:18:58 +01:00
Paul Eggleton
e7559be8d5 ref-manual: add passwd-expire to EXTRA_USERS_PARAMS
Add a reference to the recently added passwd-expire command in
EXTRA_USERS_PARAMS.

(From yocto-docs rev: 9a6c8b37a1e6baab4dfb2ffe7b4abdf7dcbb8822)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-15 20:18:58 +01:00
Paul Eggleton
bf68c627b1 ref-manual: add python3targetconfig class and remove python 2 references
Add the recently added python3targetconfig class. Also, we no longer
have the python 2 classes, remove all references to those.

(From yocto-docs rev: c63d88656e2fc5361c512d4d9b426260c3e339f3)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-15 20:18:58 +01:00
Paul Eggleton
70441f2b73 ref-manual: add REQUIRED_VERSION and adjust PREFERRED_VERSION entry
Add REQUIRED_VERSION, add a reference to it in PREFERRED_VERSION and
adjust the opening statement to read slightly better.

(From yocto-docs rev: c1c0b3600f2f6e752faacfc877b80c2dda7cf522)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-15 20:18:58 +01:00
Paul Eggleton
71b78ef384 ref-manual: and SDK_CUSTOM_TEMPLATECONF to glossary
(From yocto-docs rev: dc23e9cf8fa161388a52deae5e6c9da54c6573d5)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-15 20:18:58 +01:00
Paul Eggleton
06e98c4b80 overview-manual: fix git command line
There was an en dash here instead of a hyphen; this meant that the
command line could not be copied and pasted verbatim. (Admittedly that
is less likely here than in other examples, but let's correct it
anyway.)

(From yocto-docs rev: 4f289752fab3529516ad44e6e62a1042c339fd13)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-15 20:18:57 +01:00
Paul Eggleton
6a4a9e8333 ref-manual: update/fix text for SDK_VERSION
DISTRO_VERSION snapshot versions use METADATA_REVISION not DATE in
hardknott and thus the default for SDK_VERSION has been updated, so
update it here as well. Additionally, fix the text so it makes sense.

(From yocto-docs rev: 7b0c4229591d6325384800137e9242c2b030e118)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-15 20:18:57 +01:00
Paul Eggleton
8396001238 Use variables for minimum host versions and bump Python to 3.6
Minimum Git, tar, Python and gcc versions are specified in quite a few
different places. Let's add some variables for these so there's no
chance of missing one if they're updated in future. Additionally, for
hardknott the minimum Python version is 3.6 so set that as the value for
Python.

(From yocto-docs rev: 9a802bc4bb0438c2540f360a08c7787caf64408a)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-15 20:18:57 +01:00
Paul Eggleton
b56736ae76 ref-manual: add METADATA_REVISION and METADATA_BRANCH
These are not new variables, but we are using METADATA_REVISION in a new
place and thus need to refer to it.

(From yocto-docs rev: 3b80ece864e8cc06f09d3d4ee645ddeef5d4eaf6)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-15 20:18:57 +01:00
Nicolas Dechesne
ddc9e2fd33 docs: add a top level page for bitbake documentation
The top level index file includes a link to the Bitbake
documentation. This link is static, however the location of the
Bitbake documentation depends on the intersphinx configuration. As
such, when looking at an old YP docs release, the link to the bitbake
documentation is always the same (and wrong).

Since we cannot use a cross reference in a toc index, this patch
creates an intermediate page for bitbake documentation, and in that
page we insert the right link to the bibtake documentation
(e.g. :doc:`bitbake:index`) which will be adjusted dynamically based
on intersphinx config.

(From yocto-docs rev: 4f7f451df266a307b34bf145b29291ca85eb882f)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Tested-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-09 15:24:46 +01:00
Quentin Schulz
c380ba5a17 docs: replace anchor links
Anchor links are treated by Sphinx as external links and are not checked
during build, meaning it is impossible to know if a link becomes broken or
not.

As a matter of fact, most of the anchor links replaced in this commit
were actually broken.

The README now states that anchor links are forbidden so that there's no
need to go through such a change later on.

(From yocto-docs rev: de9e4d26b46afa3c79137d07529a74553400d2e0)

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-04-09 15:24:46 +01:00
Ulrich Ölmann
802ac0b75e sdk-manual: fix typo
(From yocto-docs rev: 5bde446a0335ccf7f3d772e1eef666aeb31eace3)

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-09 15:24:46 +01:00
Michael Opdenacker
aeb59935e9 manuals: fix suspicious newlines
- That could originate from documentation migration issues
- Checked that the corresponding links still exist

(From yocto-docs rev: 38bae8f6067bc12f3617ed38587737d22dd7b32c)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-06 22:29:49 +01:00
Michael Opdenacker
9df4fd6d39 ref-manual: fix typo
- Fix an obvious typo

(From yocto-docs rev: 03bbd66ddb85acddcfa0c588cfd29e2eac15d3db)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-06 22:29:49 +01:00
Michael Opdenacker
37ff21babe overview-manual: style improvements
- A few style improvements
- Fix a few typos

(From yocto-docs rev: 116484a850bdd9b8b648d919fd9c8858f6c55e21)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-06 22:29:49 +01:00
Michael Opdenacker
44d0532c89 manuals: Fix typos and spacing
Fix double words, punctuation spacing issues, spacing issues,
"its" instead of "it's", and other trivial issues.

(From yocto-docs rev: 56eb1f340a7af112e62c1d8ad02d4bec0ad88313)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-06 22:29:49 +01:00
Janne Kiiskila
5480a85f01 poky.yaml: Use git instead of git-core for Ubunti
Ubuntu has changed packaging and git-core is not available anymore,
it is now just plain git.

$ sudo apt-get install git-core
[sudo] password for jankii01:
Reading package lists... Done
Building dependency tree
Reading state information... Done
Note, selecting 'git' instead of 'git-core'
git is already the newest version (1:2.17.1-1ubuntu0.8).
The following package was automatically installed and is no longer required:
  linux-hwe-5.4-headers-5.4.0-65
Use 'sudo apt autoremove' to remove it.
0 upgraded, 0 newly installed, 0 to remove and 13 not upgraded.

Documentation should match the current package name to avoid confusion/warnings.

Change can be verified by running the following script

set -ex

distros=("debian:8" "debian:9" "debian:10" "ubuntu:16.04" "ubuntu:18.04" "ubuntu:20.04")
for i in "${distros[@]}"
do
   folder="${i/:/.}"      # change : to .
   mkdir -p $folder
   cd $folder
   echo FROM $i > Dockerfile
   echo RUN apt-get update \&\& apt-get install -y git >> Dockerfile
   echo
   cat Dockerfile
   docker build -t test-$folder .
   cd ..
   rm $folder/Dockerfile
   rmdir $folder
done

(From yocto-docs rev: 8cf3acb3b639ef0373c2f77daf0a4323a7f404b0)

Signed-off-by: Janne Kiiskila <janne.kiiskila@pelion.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-06 22:29:49 +01:00
Michael Opdenacker
ae19be727a Quick build: checkout a branch instead of a fixed tag
- Add guidelines for choosing a release
- Check-out a branch instead of a fixed tag
  This way it's possible to pull release updates later

(From yocto-docs rev: 00b45fcf7e37616b46ca003b49c83594c061c40b)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-06 22:29:49 +01:00
Michael Opdenacker
be976e3aa1 SDK manual: fix reference to appendix
Fixes [YOCTO #14307]

(From yocto-docs rev: d14bdf401114054d517c09d483947705e2a0d71d)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-06 22:29:49 +01:00
Michael Opdenacker
c643a4749c manuals: Spellcheck and capitalization fixes
- Spelling fixes found using Emacs' spelling checker
  configured for US English
- Fixes for some capitalization issues, especially some
  project names (QEMU, openSUSE, BusyBox), that were not
  consistently used with the same capitalization anyway.
- A few whitespace fixes too

(From yocto-docs rev: 05d69f17490dcc4933dcd85e57d9db53b912084a)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-06 22:29:49 +01:00
Ross Burton
07c7bdc6c2 poky.yaml: change gcc-multilib to gcc
None of the other distributions install compilers for 32-bit compilation,
and this package isn't available on arm64 Ubuntu systems.

(From yocto-docs rev: 5036fea7854c3152a0c148d8ab1668e01b38697d)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-06 15:07:55 +01:00
Richard Purdie
7ca303cdc6 documentation/poky.yaml: Fix latest 3.2 series tag reference
This was accidentally missed in the last release update, fix it.

(From yocto-docs rev: 8a671976818381d97ae01499e9d7deb571312f7d)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-06 15:07:55 +01:00
Michael Halstead
e8e10f27b2 releases: update to include 3.2.3
Updating to build 3.2.3 docs and add missing 3.0.4 release line.

(From yocto-docs rev: 95972458c4c5ecea38676975f69afca7f0c91e35)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-06 09:45:39 +01:00
Michael Opdenacker
c6483187f9 documentation/README minor improvements
- Minor style and spelling fixes
- Add some extra details; add missing external link macros
  and explain where they are defined
- Correct where documentation can be found on the
  Yocto Project website: the "Documentation" tab
  has been replaced by "Docs" (and it's later
  shown as uppercase ("DOCS") by the current CSS, but this
  may change one day.

(From yocto-docs rev: ed7b4f318c9ba6cf501f1e551c7a8eb4aaee1396)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-03-23 22:54:55 +00:00
Dorinda
6c9829385e dev-manual/common-task.rst: Added documentation for debuginfod support
Added documentation on running debuginfod server and using it on the target.
Added the term DEBUGINFOD_URLS definition in ref-manual/variables.rst

(From yocto-docs rev: a16ae140e26482c81ce733f20f8c68c6eba55f35)

Signed-off-by: Dorinda Bassey <dorindabassey@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-03-23 22:54:55 +00:00
Michael Opdenacker
2d80d02edb Update documentation URL
(From yocto-docs rev: dcedeaeb50d094d278e114928bfb63164aa7afb2)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-03-23 22:54:55 +00:00
Michael Opdenacker
a306baf850 Do not assume working from $HOME
In the "Yocto Project Quick Build" instructions
(https://docs.yoctoproject.org/brief-yoctoprojectqs/index.html#)
there is an inconsistency that impacts several documents...

People are first instructed to clone the poky git repository, but not
mentioning from which directory. Then, it's consistent to instruct
people to run "cd poky/".

However, later in the instructions, readers are instructed to run "cd
~/poky", which assumes that cloning poky was done from the home
directory. Many other places in the documentation make such an assumption.

This change fixes this, and makes no assumption on where people
have chosen to store their data, in particular where they cloned
the "poky" repository.

This also fixes a few whitespace issues.

(From yocto-docs rev: fd4e365c85df212d7ed70fc1abb3657a4a88b294)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-03-23 22:54:55 +00:00
Robert P. J. Day
ecacf2e941 ref-manual: remove erroneous '\*' from variables list
Not sure what those leading '\*' are doing, but they're rendered
verbatim and mess up creating a linkable item.

(From yocto-docs rev: dd2e5ef733f056900cc4c9746a1e8c688cc61920)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-03-22 18:05:31 +00:00
Ulrich Ölmann
bbfe61892c common-tasks.rst: fix typo
(From yocto-docs rev: a66062216cccbe7350fdc3ee39544eeb515509ed)

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-03-11 14:05:22 +00:00
Ulrich Ölmann
5ef20853ac common-tasks.rst: fix 'wic cp' command
(From yocto-docs rev: 4d5a184b2bf5e73c036b82984be1a2dc4c8688b5)

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-03-11 14:05:22 +00:00
Alejandro Hernandez Samaniego
43a3ea41eb ref-manual: Add Az fetcher documentation
(From yocto-docs rev: c4ad59cdc2c7fde6ef4698e5f47282540d8f0d8a)

Signed-off-by: Alejandro Enedino Hernandez Samaniego <alhe@linux.microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-03-11 14:05:22 +00:00
Michael Halstead
41ee3602ed releases: update to include 3.1.6
(From yocto-docs rev: 05580e574e78039f577d58648b4ee3817c0f09cc)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-02-26 22:36:56 +00:00
Michael Halstead
5f69bf12e5 releases: update to include 3.2.2
(From yocto-docs rev: 1770c9c1e1ce9d28f6d211061010c4a802522c16)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-02-26 15:21:21 +00:00
Richard Purdie
a425e01da8 figures/yp-how-it-works-new-diagram.png: Fix spelling error underline
(From yocto-docs rev: 16c598c123cf197ddd547458fc34dd72f1eee878)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-02-20 09:28:46 +00:00
Michael Halstead
b5e634644b releases: conf: add link to 3.1.5, update to include 3.2.1 & 3.1.5
(From yocto-docs rev: 5c94f8183733bf266cd6153434b5eed22d1914c6)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-20 22:50:45 +00:00
Joshua Watt
f236145ce4 ref-manual: Clarify recommended operator for PROVIDES
Updates the documentation for PROVIDES so that it recommends "+="
instead of "=".

(From yocto-docs rev: 39b2ca1e27592488d396d5f0d76965f0006515a1)

Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-20 00:53:53 +00:00
Yoann Congal
164db40a72 documentation: Prevent building documentation with an outdated version of sphinx
Building with a outdated version of Sphinx print warnings that does not
appear on up-to-date sphinx.

This patch prevent building the documentation with any version older
than 3.1 (First version to build without warnings in my tests)

See threads "documentation: Add a simple Sphinx extension to check its version"
    https://lists.yoctoproject.org/g/docs/topic/patch_documentation_add_a/79919516
and "toaster-manual: Fix a warning related to the code-block directive"
    https://lists.yoctoproject.org/g/docs/topic/patch_toaster_manual_fix_a/79656195

(From yocto-docs rev: 4de0f3dd4d5df0a0700f704a599bb41726d15a5f)

Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-20 00:53:53 +00:00
Abdellatif El Khlifi
d8698dc755 ref-manual/ref-classes: update kernel-fitimage with Initramfs bundle and boot script
This commit adds the description of the Initramfs bundle and boot script
new features implemented in the kernel-fitimage class.

Change-Id: Ifffa6b850308aa7ceadc4f117806cffad0137137
(From yocto-docs rev: a55c16555366c0adbf4a087b86574b07972cbc52)

Signed-off-by: Abdellatif El Khlifi <abdellatif.elkhlifi@arm.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-20 00:53:53 +00:00
Quentin Schulz
e6a0be545d docs: fix missing & and ; surrounding references from poky.yaml
poky.yaml references are only replaced in files if they are prefixed by
& and suffixed by ;.

Let's fix the missing surrounding characters.

(From yocto-docs rev: 7ee4ba7a27acd87d8c728639d1b053d2e26c6e58)

Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-20 00:53:53 +00:00
Diego Sueiro
658499cacb dev-manual: Add usage of /sysroot-only in SYSROOT_DIRS
(From yocto-docs rev: adc59efc4a6c56cc3b4594a411ae618d256d6ba2)

Signed-off-by: Diego Sueiro <diego.sueiro@arm.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-20 00:53:53 +00:00
Leon Anavi
87e7057b71 common-tasks.rst: Fix GNU_HASH in hello.bb
Fix the following GNU_HASH issue in "Single .c File Package
(Hello World!)" example:

ERROR: hello-1.0-r0 do_package_qa: QA Issue: File /usr/bin/helloworld in package hello doesn't have GNU_HASH (didn't pass LDFLAGS?) [ldflags]

Reported-by: Matthew Tsenkov <matthew.tsenkov@konsulko.com>
(From yocto-docs rev: 99a53f443193c0becd48a07a2dd740bb417dcf49)

Signed-off-by: Leon Anavi <leon.anavi@konsulko.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-15 13:39:48 +00:00
Yoann Congal
827e68675a documentation: Fix a Concpets -> Concepts typo
(From yocto-docs rev: 78bdf1c25c5c546c35b5a0d246aa1bbd70d5eace)

Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-15 13:39:48 +00:00
Ovidiu Panait
d9928413a4 variables: Add documentation for KERNEL_DTC_FLAGS
Add documentation for the newly introduced KERNEL_DTC_FLAGS variable.

(From yocto-docs rev: b2d5bf48fe4e76446a38762839865176294a4a3c)

Signed-off-by: Ovidiu Panait <ovidiu.panait@windriver.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-05 13:48:57 +00:00
Elvis Stansvik
3b2b57e408 ref-manual: terms: Fix poky tarball root folder
When extracting the tarball the root folder is not named `poky`, but
e.g. `poky-gatesgarth-24.0.0`.

(From yocto-docs rev: 8c92f709cbd96310b7153dd55dae8fa4899a7818)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 11:25:57 +00:00
Paul Barker
3b298e6ddd documentation: Use https links where possible
(From yocto-docs rev: cd4c5e9928866f910ac97cf3e0612e6245da30bd)

Signed-off-by: Paul Barker <pbarker@konsulko.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-24 08:23:33 +00:00
Paul Barker
d87b99112b ref-manual: Simplify oe_lists link
(From yocto-docs rev: 9521c5b5538295d3bfa6b9b07cbf67b62b78a0dc)

Signed-off-by: Paul Barker <pbarker@konsulko.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-24 08:23:33 +00:00
Paul Barker
e2e1071452 profile-manual: Simplify yocto_bugs link
(From yocto-docs rev: 5cd7790baa27cf4222419cf562fc89ef61833c7a)

Signed-off-by: Paul Barker <pbarker@konsulko.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-24 08:23:33 +00:00
Paul Barker
58892e05f6 documentation: Simplify remaining yocto_home links
(From yocto-docs rev: e0151e039f96c1548e2ec39ae24d4b0276f49434)

Signed-off-by: Paul Barker <pbarker@konsulko.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-24 08:23:33 +00:00
Paul Barker
ddf55dca6b documentation: Simplify layerindex and layer links
(From yocto-docs rev: b157d57cc50b0a9cfaa062fa0e966b4d29eceeec)

Signed-off-by: Paul Barker <pbarker@konsulko.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-24 08:23:33 +00:00
Paul Barker
d903e586c2 documentation: Simplify oe_wiki and oe_home links
(From yocto-docs rev: 6867f54f349edede37c4085194f51342c24297ed)

Signed-off-by: Paul Barker <pbarker@konsulko.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-24 08:23:33 +00:00
Paul Eggleton
07ec4c4ee7 ref-manual: use consistent capitalisation of U-Boot
Change all instances of U-boot to U-Boot.

(From yocto-docs rev: 153c60fd9f2807c8e98105bcd4384e52e2adaa1a)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-24 08:23:33 +00:00
Paul Eggleton
f567cda0a9 variables: Add documentation for new kernel-fitimage vars
Add documentation for FIT_DESC, FIT_SIGN_INDIVIDUAL, UBOOT_MKIMAGE,
UBOOT_MKIMAGE_SIGN and UBOOT_MKIMAGE_SIGN_ARGS.

(From yocto-docs rev: 3c8c9d419d0137279ba1a4e7d3f381df93d6f12d)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-24 08:23:33 +00:00
Paul Eggleton
345fb462ef variables: explicitly state that UBOOT_MKIMAGE_DTCOPTS is optional
(From yocto-docs rev: 0ba5591c4e8dd194f87837556cedb2b9979bc6df)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-24 08:23:33 +00:00
Paul Eggleton
bde537a024 variables: clarify KERNEL_ALT_IMAGETYPE reference
Make it clear that KERNEL_ALT_IMAGETYPE is intended to allow building an
additional image type.

(From yocto-docs rev: d2f51d310028dfa50584f7dc04ea3627d14d3f1e)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-24 08:23:33 +00:00
Paul Eggleton
84c2470929 classes: minor corrections to kernel-fitimage section
Minor syntax and formatting corrections.

(From yocto-docs rev: eda1fae0dc8670ff22f10b591ce14b9bbf0455ce)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-24 08:23:33 +00:00
Michael Halstead
82b8dc9ccc releases: conf: add link to 3.2.1, update to include 3.2.1
(From yocto-docs rev: b268b1b190861cb203fa642e57794acb402280a7)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-15 23:03:47 +00:00
Nicolas Dechesne
b70318797c ref-manual: remove 'ref' from filenames
All filenames duplicate the 'manual name', which is not needed, and
make all references longer than they should. Rename all files to be as
consise as possible, and fix all references

(From yocto-docs rev: bb7e4783f45a5f67e6e4b39968f3512f43738833)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-09 12:21:27 +00:00
Nicolas Dechesne
79fecb25e1 sdk-manual: remove 'sdk' from filenames
All filenames duplicate the 'manual name', which is not needed, and
make all references longer than they should. Rename all files to be as
consise as possible, and fix all references

(From yocto-docs rev: bd8c0f7fc09a39a8bbde1c05b51693955738e148)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-09 12:21:27 +00:00
Nicolas Dechesne
3240a59758 overview-manual: remove 'overview-manual' from filenames
All filenames duplicate the 'manual name', which is not needed, and
make all references longer than they should. Rename all files to be as
consise as possible, and fix all references

(From yocto-docs rev: 4f489a40bb00be018e419802a76fec9dbee3f255)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-09 12:21:27 +00:00
Nicolas Dechesne
11c048fbea profile-manual: remove 'profile-manual' from filenames
All filenames duplicate the 'manual name', which is not needed, and
make all references longer than they should. Rename all files to be as
consise as possible, and fix all references

(From yocto-docs rev: 44405490888960208058d016e387507e21c9f478)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-09 12:21:27 +00:00
Nicolas Dechesne
a0afa48859 kernel-dev: remove 'kernel-dev' from filenames
All filenames duplicate the 'manual name', which is not needed, and
make all references longer than they should. Rename all files to be as
consise as possible, and fix all references

(From yocto-docs rev: 3d7eb2c5e1d230290c97dd8e5b528086e1d8034a)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-09 12:21:27 +00:00
Nicolas Dechesne
af6f5d821d dev-manual: remove 'dev-manual' from filenames
All filenames duplicate the 'manual name', which is not needed, and
make all references longer than they should. Rename all files to be as
consise as possible, and fix all references

(From yocto-docs rev: 00a9244587e2e63f2a5197ed0dfc89cb330f9275)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-09 12:21:27 +00:00
Nicolas Dechesne
c684a7a6d5 toaster-manual: remove 'toaster-manual' from filenames
All filenames duplicate the 'manual name', which is not needed, and
make all references longer than they should. Rename all files to be as
consise as possible, and fix all references

(From yocto-docs rev: b5a1a504caf7ffcaeca787b38bf7f11e341dfb0f)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-09 12:21:27 +00:00
Nicolas Dechesne
9e35603c12 test-manual: remove 'test-manual' from filenames
All filenames duplicate the 'manual name', which is not needed, and
make all references longer than they should. Rename all files to be as
consise as possible, and fix all references

(From yocto-docs rev: 1b1f2fbd9283ba53c74ea4231ab4391627eb4187)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-09 12:21:27 +00:00
Nicolas Dechesne
097d0c9f04 sphinx: use absolute paths for :doc: references
:doc: references can be made with absolute path instead of relative
path. This patch was generated with this command:
sed -i 's!:doc:`\.\./!:doc:`/!g' */*.rst *.rst

And a few manual fixup we made for references such as:
:doc:"FOOBAR <../xxx>"

Suggested-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: b7948ec7eb8172b8eae4bfa5c21aab76e123ad85)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-09 12:21:27 +00:00
Nicolas Dechesne
bd17892611 sphinx: rename top level document in each manual
It is more common to call the top level document index.rst. This is
what this patch is doing, along with all required references fixup.

(From yocto-docs rev: 2cea7fbba9210479fc0387d7e1b80da9885558f0)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-09 12:21:27 +00:00
Paul Barker
332159dd3e ref-manual: Simplify oe_git links
Manual links to git.openembedded.org are converted to use the oe_git
directive where possible. Note that this directive can't be used in some
places such as example code.

(From yocto-docs rev: 64d2b5c26889356d4eb49896566cf28b9234b9cc)

Signed-off-by: Paul Barker <pbarker@konsulko.com>
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-03 12:04:21 +00:00
Paul Barker
48748377a4 documentation: Simplify yocto_git links
The yocto_git external link directive is modified to include the
`/cgit/cgit.cgi` element of the URL so that we can simplify the links in
the text.

Manual links to git.yoctoproject.org are converted to use the yocto_git
directive where possible. Note that this directive can't be used in some
places such as example code.

(From yocto-docs rev: 3a8ba5dcc783411c73fe49fb217cbc4d6528d9a7)

Signed-off-by: Paul Barker <pbarker@konsulko.com>
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-03 12:04:21 +00:00
Paul Barker
8faafa99cc documentation: Simplify yocto_wiki links
The `yocto_wiki` external link directive is modified to include the
`/wiki` element of the URL so that we can simplify the links in the
text.

Note that there are still a couple of places where this directive
cannot be used, such as in the table of contents in index.rst.

(From yocto-docs rev: d8aa5f93d349f27db3d03a2c4bcc205649f45a8d)

Signed-off-by: Paul Barker <pbarker@konsulko.com>
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-03 12:04:21 +00:00
Nicolas Dechesne
62c061968c dev-manual: remove unused labels
(From yocto-docs rev: e1bcfe4d8086f65511569278119be9b38b262108)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-03 12:04:21 +00:00
Nicolas Dechesne
0260421634 overview-manual: remove unused labels
(From yocto-docs rev: ffbb7ef3fea2964f3d9ea2ad02e71692a7d96713)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-03 12:04:21 +00:00
Nicolas Dechesne
678b85679e sdk-manual: replace labels with references to section title
(From yocto-docs rev: d6ed0b0f1317778abe02f1da148d2fcf09e81fcf)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-03 12:04:21 +00:00