Commit Graph

58617 Commits

Author SHA1 Message Date
Robert P. J. Day
3c872185c8 ref-manual/ref-variables: "PACKAGE_FEEDS_ARCHS" -> "PACKAGE_FEED_ARCHS"
Fix single misspelling.

(From yocto-docs rev: b2c27374ccd7266a1296141ea409b57f2b3842c3)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit e1a47857f4ff3edb105e7fa80ff8d29dcc3ece03)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:02 +00:00
Richard Purdie
c665a29e79 dev-manual: Add a note about prelink changing prebuild binaries
(From yocto-docs rev: 515cfe544ff7a96c20b3f94061e54fb60a8725f7)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 6c023ee1328bb31ececd9e1daaac67351c8320e3)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:02 +00:00
Paul Eggleton
3fc4576c84 ref-manual: add IMAGE_LINK_NAME
Add IMAGE_LINK_NAME to the variable glossary.

(From yocto-docs rev: 83ec0ccbf1b5f58f730c739ee7bcfc3d4afabf1d)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 370551f961a291f7090a8a40a0beea3511274bc1)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:02 +00:00
Paul Eggleton
7fdf20dd45 ref-manual: add IMAGE_NAME_SUFFIX variable
Add a variable glossary entry for IMAGE_NAME_SUFFIX, which was added way
back in krogoth.

(From yocto-docs rev: 8158dd587b9ea0085bd9a4bde04d41ef4fdd7f62)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 78920a8ea5fb991606300c1fcb48aa6a7c20f8c1)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:02 +00:00
Paul Eggleton
8967361841 ref-manual: add IMAGE_VERSION_SUFFIX variable
Add an entry to the variable glossary for IMAGE_VERSION_SUFFIX (which
was added in thud) and update the IMAGE_NAME and KERNEL_ARTIFACT_NAME
entries whose defaults use this variable.

(From yocto-docs rev: 0bf966138d4f042de4d5a2fea3b604165f596efe)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 1a02c4be8e348687d4f7e09aefc408aaed5f1be5)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:02 +00:00
Richard Purdie
bc491d6956 ref-manual/faq: Add entry for why binaries are changed in images
(From yocto-docs rev: 33915ef51d0661c4dc76c572456a10a54fba960b)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 843a91187783b2e11512c45b8dd8302b19113569)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:02 +00:00
Paul Eggleton
b591dcd33e ref-manual: fix for features_check class change
distro_features_check was renamed to features_check and extended to
support MACHINE_FEATURES, COMBINED_FEATURES and ANY_OF_*_FEATURES in
dunfell, but the documentation still needed to be updated.

(From yocto-docs rev: 3d565c61086c235f77d967acf7599e64f5944cb4)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 274eb596582a22883e8b386a07cf32ed45a77d79)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:02 +00:00
Paul Eggleton
bb16108231 ref-manual: add reference anchors for each QA check
Make it possible to link to the explanation for a particular QA check.

(From yocto-docs rev: 4274fa0966f9870baaeeb43e693c612f9e9c5c87)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 3f6dc24e0a371feca8fe66c1be8c86e599307854)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:02 +00:00
Quentin Schulz
8b94856238 docs: kernel-dev-faq: update outdated RDEPENDS_kernel-base
Since 2.5 (sumo), RDEPENDS_kernel-base has been replaced by
RDEPENDS_${KERNEL_PACKAGE_NAME}-base, so let's use this one instead.

(From yocto-docs rev: 1eb4922610c8469af75a6efd9d4b505968d6e6a2)

Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 0639160185969a6761e9911a166b897a015f4d59)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:02 +00:00
Quentin Schulz
494492a893 docs: kernel-dev-common: add .patch file extension to SRC_URI files
Patches provided in SRC_URI are only applied if their extension is .diff or
.patch. The examples do not use those extensions and would probably result
in user confusion as to why the patches aren't being applied to the
sources.

Let's fix this by giving them a .patch file extension.

(From yocto-docs rev: 80a01f141b3f09f42b53f3ef4d380fba6551fe90)

Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 0858e86ed8e3e3005207980041fe4f2117750663)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:02 +00:00
Quentin Schulz
c05ff1dc60 docs: kernel-dev: fix typos, highlights and links
(From yocto-docs rev: 35bf202fb725ce9f0ae28023e36bb8568ac3885d)

Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit a69247321ff34cb0a2b9a8cc62020ec7f3aad834)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:02 +00:00
Nicolas Dechesne
3362474c3e sphinx: add 3.1.3 and 3.0.4 release in the switcher
(From yocto-docs rev: 3fa0e1c53dd7e40a11e0b1216b468e18cac20c18)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 64c7cb54e031b5b0babc8ee33dac0b9162a5f391)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:02 +00:00
Joshua Watt
44f8c6b682 ref-manual: Document wic --offset option
Adds documentation that describes how to use the --offset argument in a
kickstart file

(From yocto-docs rev: d993d9353fd27a9c9beebdef180a2adf36099514)

Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 0fbb2d71fe866b4ae7721f2f70d5b50dbc019030)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:01 +00:00
Quentin Schulz
5100881891 docs: bsp-guide: bsp: fix typos, highlights and links
(From yocto-docs rev: 2ce227fb131ae2052218a3008a80ba8a98a19cce)

Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit cb0e11170b34b332b41f8b533545c69b05c696c0)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:01 +00:00
Quentin Schulz
54fc7c6e20 docs: ref-manual: ref-terms: add links to terms in glossary
Everything declared in a glossary has a "term-" link that is usable as an
HTML anchor. The link already works, one just cannot get a link from
within the ref-terms page.

Let's make this possible.

Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
(From yocto-docs rev: b56c2d5bbf05e813656f2472f92f1f9b4db9bba2)

Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit fcbb267fba968834d4d9d011fc71cc371f910447)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:01 +00:00
Joshua Watt
b32c77e807 ref-variables: Given example for naming sources
Adds an example to SRC_URI that explains how to name sources in SRC_URI
and how to associate SRCREVs and checksums with the names

(From yocto-docs rev: 15d16cced2cccfc120975e5687c45b5aab3dd6eb)

Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 900af0addab7d6ea465922957f881a13012429ed)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:01 +00:00
Quentin Schulz
a2274632af docs: dev-manual: fix typos, highlights, indentation and links
(From yocto-docs rev: 97b9e0c8b7723b7daf1534ccd5cadf65ea03f724)

Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit ab244dcd48968ea6d0e328808c9aac4aef281032)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:01 +00:00
Quentin Schulz
3ae9ead271 docs: dev-manual-common-tasks: update python webserver example to python3
SimpleHTTPServer is python2 only, the module in python3 is http.server.

Let's use this one since everything in Yocto Project is using python3
nowadays.

(From yocto-docs rev: a5922b045eca9aa96672f8d75a2f98e17d2280f7)

Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 75338f17b116afadb7360181d071875a68272708)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:01 +00:00
Quentin Schulz
cbad23de16 docs: dev-manual-common-tasks: remove paragraph about race when missing DEPENDS
Missing DEPENDS were an issue before rocko (2.4) because of a shared global
sysroot. Since then, every recipe has its own sysroot, it is not possible
to build successfully a recipe without all DEPENDS. Therefore, races in
tasks possibly triggered by missing DEPENDS are a thing of the past.

This paragraph is misleading and can be safely removed.

(From yocto-docs rev: 8547d2623b32d33758b326e735509dc0a13625fc)

Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 9aec42794846a4bca37b49a9f920fa2887974ddf)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:01 +00:00
Nicolas Dechesne
cb040a4650 sdk-manual: use built-in footnotes
The current HTML output is bogus, because we have a fix of * and \.
Sphinx has built-in footnotes that can be used in this specific
example. let's use that instead.

(From yocto-docs rev: ebac4486e711152962bb8cd22b55ddce332b07f6)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 5be36103ca1102c995915a20bf881e43920595e3)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:01 +00:00
Quentin Schulz
ddbd52488f docs: poky.yaml: fix identation in host packages variables
This unfortunately makes the variables probably unusable for proper
replacement in other indentation blocks.

(From yocto-docs rev: 2f66f0bd7d9167fc49779d7b9ab1e4388bca4428)

Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit adf240b8db9597328324bbfb0095f573bea217f9)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:01 +00:00
Quentin Schulz
47cb48f36e docs: sphinx: yocto-vars: rebuild files when poky.yaml has changed
poky.yaml changes aren't detected by Sphinx by default.

In order to detect changes in poky.yaml, its md5sum is stored in the
app.outdir (BUILDDIR/html when building html) and checked against the
md5sum of the poky.yaml under use.

If the md5sum has changed, find all rst files in app.srcdir that have at
least an occurence of `&.*;` and mark them as requiring a rebuild.

(From yocto-docs rev: 3816a23462ad9eafbf49d455d06e64638de8ea26)

Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 59537c7fa49e3ea6918f45b3201ad16d56988b9b)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:01 +00:00
Quentin Schulz
4030fd0f3c docs: ref-manual: ref-system-requirements: update requirements to build Sphinx docs
Tested with containers on all supported distributions.

Debian 8 (Jessie) still has Python3.4 and an old pip3, which makes it
impossible to build typing module which is a requirement of "new" Sphinx
python module.

One cannot update to latest pip3 from within pip in Jessie's version.
One cannot get a newer pip from upstream because newer pip don't support
Python3.4 anymore.
One cannot build with python3-sphinx package from Jessie because the
package is too old (1.2.3) and does not have sphinx.ext.autosectionlabel
module which appeared in 1.4 version.

(From yocto-docs rev: db2e97515636674a0b04d2fe3f35b433b49b6c0f)

Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 14da565986a573ac7e0b5c5943e55b7b74f99dd5)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:01 +00:00
Quentin Schulz
ccb3a1db76 docs: ref-manual: ref-classes: remove dropped tinderclient class
tinderclient class was dropped in dunfell.

Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
(From yocto-docs rev: cc7d66576a4c4cdfaa0643b8e0e7dc0549a25599)

Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 241059880bbfa61b61cf1843447e1b6d57c71ebe)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:01 +00:00
Quentin Schulz
8b8656d0d8 docs: ref-manual: migration-2.3: specify 2.3 version instead of DISTRO
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
(From yocto-docs rev: c3e958c3b31c2288fd5e04b9f5efe22e8ccade3c)

Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 19b3ce7bc46b76207a6f3733881f3f16deab5a0d)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:01 +00:00
Quentin Schulz
ec92701ee5 docs: ref-manual: fix typos
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
(From yocto-docs rev: 2d5206044db1885e8625721e1e48579d80b95852)

Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit f21e92f74c8357b23fd4059af6815fbba9487147)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:01 +00:00
Quentin Schulz
755ff8dcaa docs: remove OE_INIT_FILE variable
There's probably no need for such a variable (the name of the script is
unlikely to change any time soon) and not all instances of
oe-init-build-env were actually using this variable.

For consistency sake, let's just remove the OE_INIT_FILE variable.

Suggested-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
(From yocto-docs rev: 322b9a676b8897d93fe046b4c37a745d472cd4c6)

Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 6fd4421283005b0ecc980e9ef25770d383b93937)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:01 +00:00
Quentin Schulz
e8feec005b docs: ref-manual: indentation, links and highlights fixes
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
(From yocto-docs rev: 27f6527882d22f20641882018ca5b8a7a30092ae)

Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit f5688a74cd9d100dee270edb9a33c02015cfabda)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:01 +00:00
Quentin Schulz
017be0a956 docs: poky.yaml: use HTTPS for links
Manually tested, ran linkcheck on it too.

Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
(From yocto-docs rev: 9099cd175a65aedff03a43ed43de90217750dc3c)

Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 46912c4c7e429f01dba52071efa649e8c4fbaf06)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:01 +00:00
Naoki Hayama
76eba84fa7 dev/test/ref-manual: Fix typos
Fix some typos.
s/necesary/necessary/
s/overriden/overridden/

(From yocto-docs rev: 31f64af42474cbf965f9c9c216ad44939d9f498b)

Signed-off-by: Naoki Hayama <naoki.hayama@lineo.co.jp>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit f4ce6ae80b1d96f9b8bead013642aeda0c776182)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:01 +00:00
Richard Purdie
08f1051ead docs: Fix license CC-BY-2.0-UK -> CC-BY-SA-2.0-UK
When the license identifier tags were added, an incorrect string was used
and the Share-Alike clause was lost. Fix this to match the license
description in the files and add back the lost piece (its clear from
the history it should be there)

(From yocto-docs rev: ac9eede80f19c6e2138406209ab5700e89a244a0)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 8d30c3d792755a7bfdb74b331dad98f51d3516af)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:01 +00:00
Nicolas Dechesne
4a6390f511 sphinx: rename Makefile.sphinx
Now that the DocBook files are removed, we can rename the top level
Makefile.

(From yocto-docs rev: eb412a93ec93b3413e23f028f33bda88f82ac688)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
(cherry picked from commit 25fefa9a91ba5d7b398443f543e2c46165e8a3f4)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:01 +00:00
Nicolas Dechesne
b175f35343 sphinx: remove DocBook files
The Yocto Project documentation was migrated to Sphinx. Let's remove
the deprecated DocBook files.

(From yocto-docs rev: abdb6b6bdfef3dc8e8cc13779e44a8d6df903469)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
(cherry picked from commit 28fb0e63b2fbfd6426b00498bf2682bb53fdd862)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:01 +00:00
Quentin Schulz
a934ad95cf docs: ref-manual: ref-variables: add links to terms in glossary
Before the move to Sphinx, it used to be possible to get a direct link to a
variable from the term glossary. It is very useful when pointing people to
a specific variable when manually looking for it in the glossary.

Let's add this "feature" back.

(From yocto-docs rev: ee811e9f351eb79987dcdc2c2dbbd14ac52d92ca)

Signed-off-by: Quentin Schulz <foss@0leil.net>
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 9e468274eaad270efd5f50e58a523798fcb8097e)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:00 +00:00
Quentin Schulz
23b1085ba7 docs: ref-manual: ref-variables: fix alphabetical order in glossary
(From yocto-docs rev: 7b8763580813466d10efd0c0df90dc6403f18894)

Signed-off-by: Quentin Schulz <foss@0leil.net>
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 77aa3990cab4fb01706d0b6b0284c38e4d9dda56)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:00 +00:00
Quentin Schulz
38274e2465 docs: ref-manual: ref-variables: fix one-letter pointer links in glossary
Since the move to sphinx, variables aren't linked with var- anchors but
term-.

Let's fix that so clicking on a letter will bring to the correct variable
in the page.

(From yocto-docs rev: 731d8b62ba588200d7d57cee0fd56256f32bd9a2)

Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 07718faa04a8b121be004afbc23b4c338f669413)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:00 +00:00
Nicolas Dechesne
234055a332 sphinx: fix up some trademark and branding issues
The following changes were required after a review of trademark and
branding guidelines:

1. add (R) to 'Yocto Project' on the top left (above the logo)
2. Fix up the capitalization of the  main page title
3. Add the copyright/legal blurb at the bottom of the page

For 3. it turned out to be simpler to override the whole footer.html
template, and maintain our own version. Also I took the liberty to
remove the 'next' and 'previous' buttons since I believe they are not
especially useful, given the navigation bar on the left side.

Reported-by: Tracey Erway <tracey.m.erway@intel.com>
(From yocto-docs rev: a29ee99f81aa5b3cc66493e79712a3b5dc31e23f)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 6bae1372218e0b10258e4fa6fef72fc1708a329c)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:00 +00:00
Nicolas Dechesne
6f248db9a2 sphinx: remove test-manual
This is a new manual in YP 3.2, let's remove it from the 3.1 Sphinx backport.

(From yocto-docs rev: baf4410abad44b7f1fc6e4f1c445060b87c21c32)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:00 +00:00
Nicolas Dechesne
8408c03763 sphinx: reintroduce changes for 3.1.1, 3.1.2, 3.1.3 and 3.1.4
The following changes were undo'd when the Sphinx docs were backported
in dunfell:

069c27574 Documenation: Prepared for the 3.1.1 release
bd140f0f9 Documentation: Add 3.1.1 version updates missing from previous commit
17cc71a8f Documenation: Prepared for the 3.1.2 release
1a69e2c02 Documenation: Prepared for the 3.1.3 release
8910ac1c7 Documenation: Prepared for the 3.1.4 release

In this commit, we reintroduce the content related to these patches,
but in the .rst files.

(From yocto-docs rev: a6a1b8e9df26b4b4ccf5c5c9cc3c02fa156cf81f)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:00 +00:00
Nicolas Dechesne
7af1c35b57 sphinx: undo (ref-system-requirements: update supported hosts lists)
This change was made in Sphinx/master, but does not apply to
dunfell. Since we inherited it from the Sphinx migration, we need to
undo it.

(From yocto-docs rev: f5132957398af9644188cf010acec55bca6e8a8e)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:00 +00:00
Nicolas Dechesne
fa0cb4d34b sphinx: import docs
The Yocto Project docs was migrated from Docbook to Sphinx in YP
 3.2. This 3.1 is an LTS release, and since 3.1 docs are 'close to'
 the docs in 3.2, we agreed to backport sphinx docs onto 3.1.

This first patch brings all changes done in 3.2 until:
7f64574f7 README: include detailed information about sphinx

There are other changes after this commit, but they will be
 selectively backported in individual patches.

This patch was generated with the following command:

git cherry-pick -n \
 $(git log --reverse --oneline \
 ac352ad7f95db7eeacb53c2778caa31800bd7c26..7f64574f7 \
| cut -f1 -d' ')

The following commits were applies in the dunfell docs, but not in
master, so they were first reverted (and squashed into this change). A
commit will reintroduce the content from these patches in the Sphinx
files in a followup patch.

069c27574 Documenation: Prepared for the 3.1.1 release
bd140f0f9 Documentation: Add 3.1.1 version updates missing from previous commit
17cc71a8f Documenation: Prepared for the 3.1.2 release
1a69e2c02 Documenation: Prepared for the 3.1.3 release
8910ac1c7 Documenation: Prepared for the 3.1.4 release

(From yocto-docs rev: c25fe058b88b893b0d146f3ed27320b47cdec236)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:00 +00:00
Mert Kirpici
a038e58f3c bitbake: doc/conf.py: add missing import sys
Due to the calls to sys.stderr.write() and sys.exit() in exception
handling in case of sphinx_rtd_theme not being installed, the
following exception is raised by Python due to the fact that sys
module not being imported.

(Bitbake rev: a394eeec6aeb98c6395cb5da2036ce936bdaa0a0)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 5ddf0e5bee0de59d07295fc5693e20b1a0380fde)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:00 +00:00
Nicolas Dechesne
49f6f45ad6 bitbake: sphinx: partial undo (bitbake-user-manual: update perforce fetcher docs)
This change is not applicable to 1.46/dunfell branch, and was brought
by the automatic backport of Sphinx docs, so let's undo it. Note that
this patch also included a general statement which applies to 1.46, so
this snippet was not removed.

(Bitbake rev: b164cf6790e47271a0848104a6c9507dd35c7f8f)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:00 +00:00
Nicolas Dechesne
f3f5639379 bitbake: sphinx: undo (bitbake-user-manual: Remove TERM from BB_HASHBASE_WHITELIST example)
This change is not applicable to 1.46/dunfell branch, and was brought
by the automatic backport of Sphinx docs, so let's undo it.

(Bitbake rev: 07bc934fab62c0a238ec62a8516396191095a231)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:00 +00:00
Nicolas Dechesne
22384b2fe5 bitbake: sphinx: import sphinx docs
The Bitbake manual was migrated to Sphinx in Yocto Project 3.2. Since
the docs between 3.2 and 3.1 are "similar", and since 3.1 is an LTS
release, we agreed to backport the documentation onto 3.1.

If we look at all docs changes in 3.1 and 3.2, we have the following:

=== Changes in 3.1
git log --oneline b94dec477a8d48ebceec91952ba290798c56c1f5..origin/1.46 -- doc/
====
324aaa7f bitbake-user-manual-metadata.xml: fix a minor error
f92e19a3 doc: More explanation to tasks that recursively depend on themselves
e4695176 doc: Clarify how task dependencies relate to RDEPENDS
25c5c79b user manual: properly tag content as <replaceable>
be367887 docs: delete reference to obsolete recipe-depends.dot

=== Changes in 3.2/master
git log --oneline b94dec477a8d48ebceec91952ba290798c56c1f5..origin/master -- doc/
====
a7c47f1e sphinx: rename Makefile.sphinx
427721d8 sphinx: remove DocBook files
d52190ea docs: static: theme_overrides.css: fix responsive design on <640px screens
9ae5cce7 docs: sphinx: report errors when dependencies are not met
ec4c481a docs: update README file after migrationg to Sphinx
c87cc35a docs: sphinx: replace special quotes with double quotes
ebdeef2c docs: ref-variables: add links to terms in glossary
29081375 bitbake-user-manual: fix bad links
a0f37789 sphinx: theme_override: Use bold for emphasis text
cbc5ca48 sphinx: theme_override: properly set font for verbatim text
08b1ae23 sphinx: remove leading '/'
99ba6fe9 sphinx: update style for important, caution and warnings
d99760cc sphinx: last manual round of fixes/improvements
4f94633a sphinx: bitbake-user-manual: insert additional blank line after title
63adcaa5 sphinx: add releases page
3e940d93 sphinx: conf: enable extlinks extension
9921c652 sphinx: index: move the boilerplate at the end of the page
4e461224 sphinx: add SPDX headers
cb19159c sphinx: Enhance the sphinx experience/nagivation with:
10a54678 sphinx: tweak html output a bit
219b2348 sphinx: Makefile.sphinx: add clean and publish targets
35fdc185 sphinx: fixes all remaining warnings
e11d2dd1 sphinx: fix links inside notes
57300955 sphinx: fixup for links
fa304c01 sphinx: override theme CSS
29af1cd2 sphinx: switch to readthedocs theme
e8359fd8 sphinx: bitbake-user-manual: use builtin sphinx glossary
6bf6c8d6 sphinx: initial sphinx support
84ccba0f sphinx: add initial build infrastructure
44b57216 bitbake-user-manual: update perforce fetcher docs
9186ca47 bitbake-user-manual: Add BBFILES_DYNAMIC
7689fa78 bitbake-user-manual: Remove TERM from BB_HASHBASE_WHITELIST example
06b5cf0a bitbake-user-manual-metadata.xml: fix a minor error
c92a266c doc: More explanation to tasks that recursively depend on themselves
caf42243 doc: Clarify how task dependencies relate to RDEPENDS
647c13d4 user manual: properly tag content as <replaceable>
2effbb6e docs: delete reference to obsolete recipe-depends.dot

We can conclude the following commits exist in 3.2 and not in 3.1 (if
we filter out sphinx changes)

44b57216 bitbake-user-manual: update perforce fetcher docs
9186ca47 bitbake-user-manual: Add BBFILES_DYNAMIC
7689fa78 bitbake-user-manual: Remove TERM from BB_HASHBASE_WHITELIST example

Out of these 3 changes, the following patches are for 3.2 only:
44b57216 bitbake-user-manual: update perforce fetcher docs
7689fa78 bitbake-user-manual: Remove TERM from BB_HASHBASE_WHITELIST example

To backport the Sphinx docs, we then need to cherry-pick all docs
patches from 3.2/1.48 and 'undo' the two patches above.

This first patch is the first step that imports all Sphinx files, and
remove Docbook files. It was done with the following command:

git cherry-pick -n \
 $(git log --reverse --oneline \
 b94dec477a8d48ebceec91952ba290798c56c1f5..origin/master -- doc/ \
 | cut -f1 -d' ')

(Bitbake rev: cd68f14031eb45006b44d10b348e35c69ac21ad0)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04 10:55:00 +00:00
Robert Joslyn
16d477fa5d openssl: Update to 1.1.1i
This fixes a NULL pointer dereference in GENERAL_NAME_cmp function.

CVE: CVE-2020-1971

(From OE-Core rev: fcd335e2a721d8db6e2fdac483798ced0ff3e1ad)

Signed-off-by: Robert Joslyn <robert.joslyn@redrectangle.org>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-01 11:55:35 +00:00
Richard Purdie
7d08b1916d cups: Mark CVE-2008-1033 as a non-issue
It only applies to MacOS.

(From OE-Core rev: 6ebf7c268fbbf7e7b2411ba0888e141187020017)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit cad1162f41c4c060744b98109514f761aa64d34a)
Signed-off-by: Steve Sakoman <steve@sakoman.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-01 11:55:35 +00:00
Richard Purdie
5e2b40da1d cups: Mark CVE-2009-0032 as a non-issue
The CVE was against a cups plugin which is obsolete and we don't include.

(From OE-Core rev: 7a5123aa30fe4f19bf6daa7278e29283be05dab1)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 5f7cb9f6ec4b14f992d265b8c67a9f5589f9b842)
Signed-off-by: Steve Sakoman <steve@sakoman.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-01 11:55:35 +00:00
Steve Sakoman
18a3a31131 cups: whitelist CVE-2018-6553
This an Ububtu specific issue:

The CUPS AppArmor profile incorrectly confined the dnssd backend
due to use of hard links. A local attacker could possibly use this
issue to escape confinement. This flaw affects versions prior to
2.2.7-1ubuntu2.1 in Ubuntu 18.04 LTS, prior to 2.2.4-7ubuntu3.1
in Ubuntu 17.10, prior to 2.1.3-4ubuntu0.5 in Ubuntu 16.04 LTS,
 and prior to 1.7.2-0ubuntu1.10 in Ubuntu 14.04 LTS

(From OE-Core rev: e30fd2421da579b7d1e799c7d267395026a780dc)

Signed-off-by: Steve Sakoman <steve@sakoman.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 22e89983a8f83a369d83bc67e4f3492bc50db648)
Signed-off-by: Steve Sakoman <steve@sakoman.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-01 11:55:35 +00:00
zangrc
ac15769c82 bash: Rename patch name
Because the name of CVE patch is wrong, cve-check-tool cannot get the correct CVE result. Rename the patch name.

(From OE-Core rev: 33beb4fc5f23206ccb2f8d81e0135bbc575e238d)

Signed-off-by: Zang Ruochen <zangrc.fnst@cn.fujitsu.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 422f9af7d0f7de7a2e933154853e7a281f98ab93)
Signed-off-by: Steve Sakoman <steve@sakoman.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-01 11:55:35 +00:00