To better reflect the subdirectory structure,
as suggested in [YOCTO #14543]
(From yocto-docs rev: a35d1b546c219407bc93c87789a7147a9ade270e)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Also include this directory in alphabetical order.
(From yocto-docs rev: f9156f413053a5f19bd59c83a1f6f24eb02a57e1)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add this to the quick description of build/ in the toplevel
directory structure.
(From yocto-docs rev: 380143e2c47afb613e45e9cd664e298738f858fa)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
As reported in [YOCTO #14502], the description of BBPATH in the
Yocto Project Manual is redundant with its description in the
BitBake User Manual.
(From yocto-docs rev: 5feb4e174e0aec6a48b1131889a5b8547b9b9921)
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>
Document default machine features defined in Poky, and which
were not listed in the documentation yet.
Took the values of DISTRO_FEATURES_DEFAULT and POKY_DEFAULT_DISTRO_FEATURES:
meta-poky/conf/distro/poky.conf:DISTRO_FEATURES ?= "${DISTRO_FEATURES_DEFAULT} ${POKY_DEFAULT_DISTRO_FEATURES}"
Also explain that extra layers can define their own features.
This addresses [YOCTO #14515]
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This now includes a description about how to create a template
with the newly added tooling, and drops the description
of .templateconf as a way to point to a custom template
(which is not correct: .templateconf is used only to point to a default
template in poky or core when TEMPLATECONF is not specified).
(From yocto-docs rev: d8e43d4ff4d6a0a4557d5dcedf11c1e45a223e72)
Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This is really not needed as the sub-commands are described in
greater detail just below, and is prone to become outdated.
(From yocto-docs rev: 70735edb17c3c855a77318d3ae44d24d8aa8eb75)
Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
It's better to use SRC_URI += to append patches etc. If anything
is added via :append, that can only be removed with :remove which
makes the changes rather permanent compared to light weight +=
amendments.
(From yocto-docs rev: 99f9a1705726b170187a58752ac9e62f56d0863d)
Signed-off-by: Mikko Rapeli <mikko.rapeli@linaro.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Using SRC_URI:append without recipe, machine or architecture specific
limitations makes the :append'ed text more difficult to override than if
the "+=" operator was used. This makes it hard for example to override
SRC_URI completely in a bbappend to update the full recipe to a newer
version. Thus common, reusable layers which users are meant to re-use
and customize should not use SRC_URI:append but SRC_URI += instead.
(From yocto-docs rev: 34533ac2ee5d85a41330dd865062dce1e46b83fc)
Signed-off-by: Mikko Rapeli <mikko.rapeli@linaro.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This variable is used to denote the C/C++ compiler runtime to use.
Right now there are few alternatives out of the core which could
use this variable to define this property, the values it can take
are 'gnu' for gcc runtime. 'llvm' for using compiler-rt+libc++ and
'android' to use android runtime. Default settings is to use gnu
which is current silent default also.
(From yocto-docs rev: 9094510e08b3a7b215b0d3ebecf66475a57b4c7e)
Signed-off-by: Khem Raj <raj.khem@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The templates have recently been moved by meta-yocto's commit [1].
Clean up some whitespace issues along the way.
[1] 29608bd03e1b ("meta-poky/conf: move default templates to conf/templates/default/")
(From yocto-docs rev: 661c554224dd79e79afd22b84608e248d3336aac)
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>
(From yocto-docs rev: a587eb476219cb1d6a9b104f4d7470c0d2da3c90)
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
numa is an existing machine feature, add it to the list so that users
are aware of it.
(From yocto-docs rev: 6022d15b8ee5e038d2f1c0f061a871dba40e5213)
Signed-off-by: Jon Mason <jdmason@kudzu.us>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In fact, all the same tasks can be done directly from a Yocto build. Let's just
drop the steps to produce and install the eSDK - if someone wants it, the SDK
manual covers everything.
(From yocto-docs rev: 582aa6a8e461bbd698b121403dcd25ddb563a464)
Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Commit https://git.yoctoproject.org/poky/commit/?id=d08e47312741a18e7be505d22762b90528253ac9
removed some EOL and CentOS7 from list hos supported hosts. Sync docs with Poky
Replace CentOS with AlmaLinux.
(From yocto-docs rev: 25a0e14ee8da9f59fa50ec209478e08e6438b827)
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>
inkscape and the package providing fncychap.sty TeX font were missing
from the packages to install to be able to build the documentation, so
let's add them to the list.
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 4c05a45615ef2b13e9af4b792fb97be116d889b1)
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>
The fncychap.sty font needs to be installed on the host in order to be
able to build the PDF version of the docs, so let's mention it in the
README.
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 97fb41801fb7ac1439f8af03d2da2fb2f171a7e6)
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>
The URLs are actually redirected from
https://git.yoctoproject.org/cgit/cgit.cgi to
https://git.yoctoproject.org so let's save the user a redirection and
use the most up-to-date URL.
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: cb6dcfe92638be6c1dee647daf00cfc2191694b2)
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>
For correct rendering of the note
(From yocto-docs rev: cc765028a7cd3dda6942450b3d59d283bf73a8f7)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In order to maintain one less file, let's auto-generate the releases.rst
file which contains a link for each release ever released.
This gets auto-generated by checking the tags available in this git repo
and adding a link for each that exists.
A few tags are notoriously missing from this git repo and they are
manually listed then, until the tags are pushed for the appropriate
commit.
Cc: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: c581eda3f87390b3e5223daff74d0ed6567ec51a)
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>
Literal blocks make sphinx take their text verbatim. This means that
directives cannot be used in literal blocks. This means :term:`S` was
printed as-is, without actually creating a link to the S variable
definition as would be expected outside of literal blocks.
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: ca5e076a413b0e1241eefdfccfee5bfa652cf6f8)
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>
(From yocto-docs rev: 027a58616db9f3e8ee5992b57fd99cb3c284ece9)
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This variable has been obsoleted, so remove it from the documentation.
(From yocto-docs rev: 30ed4323e7fb482e4f6f47755314354a2e5e3871)
(From yocto-docs rev: afa895871e8ec18f4861f48f70b8a54cc2e4cb98)
Signed-off-by: Ross Burton <ross.burton@arm.com>
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This reverts commit c9922076f5c1285d9cfd6aff8ce5b6635d88222f.
Since the minimum version required to build the docs has been bumped in
the previous commit to 4.0, this commit is not required. Moreover, since
Sphinx 5.0 triggers a warning when extlinks captions are not using %s
substitution and Sphinx 6.0 will fail to build without the substitution
characters, this revert is now required to be able to build the docs.
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 9db804f5c5231bee50a99730a576bff7559f9631)
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
extlinks captions support using %s substitution but only from sphinx
4.0 onwards. Anything before does not support the %s substitution.
However, this will be a requirement in sphinx 6.0 and later, and sphinx
5.0 already shows a warning telling us that.
Since the build is made with -W flag which fails it if any warning is
printed, a fix is required.
Sphinx 4.0.0 was released two years ago. Unfortunately, Debian packages
are out-of-date and only the latest Ubuntu has recent enough packages.
Therefore, pip installation should be recommended now instead and the
minimum version for building the docs bumped to 4.0.
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: ab45a7a40484a2d8e604cb45549037c526ec61cb)
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Screenshot from executing an NPM package built by npm.bbclass
(From yocto-docs rev: 57acf2f65e5e5798f369a24c4a0cc9b5cdb8e1db)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
From running the instructions using Poky master
In particular, update command output and the contents
of generated files.
The "cute-files" example application can now directly be run,
without having to run it through "node".
(From yocto-docs rev: a100fb1e25e3f2e144d771d31e952deae2fe3302)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fix some hyphens being improperly used as em dashes.
See https://www.grammarly.com/blog/hyphens-and-dashes/
Using em dashes may also allow Sphinx to hyphenate
and break lines in the best way.
Note that the first character after an em dash not
supposed to be capitalized, unless a specific
rule applies, typically when what follows is a proper noun.
Fix a few misuses of parentheses in following text.
(From yocto-docs rev: 5918f019f63f6e820b1168f4cc001faa1d1cdc6f)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Make DISTRO_FEATURES description more explicit by specifying
that DISTRO_FEATURES alone can't select build configurations,
and need mechanisms like PACKAGECONFIG setup to take care of
selecting build configurations.
Signed-off-by Aatir Manzur <aatrapps@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
(From yocto-docs rev: 4b39a4434ee658512050c50f6ebd5ad5dc900fb1)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
"empty-root-passwd" doesn't actually set an empty root password.
It just doesn't touch the initial root password which is empty by default.
(From yocto-docs rev: 793cfe841148ead7e22fc2caf045247ab27a15da)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Completing the descriptions of "debug-tweaks".
Correcting the description of "allow-empty-password"
which doesn't imply accepting root logins.
(From yocto-docs rev: 907c94886fd8a485a6045d71478e41a3c598821c)
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>
[YOCTO #14660]
(From yocto-docs rev: d5bcdf9a8b357b96656b62c41834410e662d8546)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
As enforced by meta/classes/sanity.bbclass:
- at least GNU make 4.0
- at least GNU tar 7.5 (instead of 5.0)
(From yocto-docs rev: 6480aa0f8338ef192c666b9445bc0baff47d9248)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This term is used throughout the manual but is not properly
introduced anywhere.
(From yocto-docs rev: 51426a0762a5988aa835e065f5258fd7ac474c52)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fix a wrong reference no longer tolerated by Sphinx 5.0.1
(missing "bitbake:" prefix)
Add missing double quotes in a reference to a chapter title
(From yocto-docs rev: 9a797dedf6708da3e7ce789c5c8735e5d891cde4)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Multiconfigs now work from layers. Update the documentation to match this change.
Also fix a incorrect reference to different distros working within the same TMPDIR,
that is incorrect.
[YOCTO #13566]
(From yocto-docs rev: cb35f75bfc98c9098f9af64b9dd040b25779da36)
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>
Add detail that package overrides are only available if
specified in SYSTEMD_PACKAGES.
(From yocto-docs rev: 9466c0b79348e68b1db7aefd3d95f8e7c903f1d4)
Signed-off-by: Paulo Neves <ptsneves@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
State that SYSTEMD_SERVICE allows for multiple space
separated systemd services
(From yocto-docs rev: 68f7009b06007b925e7a5b6ab085ec813d85b0bc)
Signed-off-by: Paulo Neves <ptsneves@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Hardknott and honister releases are now outdated, let's move their
manuals to the outdated section.
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: f727d18735f2a373ef11888b025f4566e046800f)
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>
Let's not maintain manually which tag should be locally available before
asking the user to run git fetch --tags. Instead, let's check for the
latest release first tag (e.g. for Kirkstone, 4.0 even though 4.0.1 is
already out).
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 7466c0c37ac193fc3d089fadd426d8a802cd0650)
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Honister 3.4.4 is the last release of the series and the series is now
considered obsolete.
Let's remove honister from the list of active releases.
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 9e90f446b16e64138ad8556de428552cac13dcc4)
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Without adding bitbake/bin to the PATH, some tests will fail when
they cannot find the main bitbake script.
(From yocto-docs rev: 1bbeb83bbff71a670ced81146732f04a947473b5)
Signed-off-by: Zachary T Welch <zach@aquabyte.ai>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The addition of the verbose example interrupted the description of the
BB_SKIP_NETTESTS option.
(From yocto-docs rev: 9d94046bdb21671e9281ba725fa3aaf9299d3989)
Signed-off-by: Zachary T Welch <zach@aquabyte.ai>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The explanations which precede and follow are sufficient.
The removed text seemed to suggest to use conf/site.conf to specify
the location of another conf/site.conf file.
Another issue was that the way to override conf/site.conf settings
through conf/local.conf was described before explaining that
conf/site.conf is processed before conf/local.conf.
(From yocto-docs rev: d477a2044e7b53977daf4d0c0d45cad29c2006fb)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add it to the variable index
Misc improvements to the documentation for this variable
(From yocto-docs rev: fb460a7c7aba1ad5754806f9cfad9ef591420317)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Better for EPUB output in particular
- Make some diagrams wider when necessary
- Remove ":align: center" when we have ":width: 100%"
- Update the standards.md files to mention this
(From yocto-docs rev: 848ba7bd8984cc3f4bf6b818259865011cde0476)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- Using "BitBake" instead of "Bitbake" or "bitbake", aligning with the
title of the "BitBake User Manual".
- Using "OpenEmbedded" instead of "Openembedded"
- Using "Python" instead of "python"
(From yocto-docs rev: 0b893e2a15aefedd7100445fc9d7eeed07b6afc6)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixing "make clean" followed by "make epub" or "make latexpdf"
(From yocto-docs rev: 0dac10fc3d170fb162f4df6547541071bfa7a94e)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Also show release names in the dropdown menu so that people have
knowledge of both the version number and release name of whatever
they're using or planning to use or upgrade to.
This patch will make the dropdown menu show the following entries:
Unstable (dev)
Kirkstone (4.0)
Honister (3.4.3)
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 83867cd979810a023eb7e2d243782e6202873273)
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>
[Yocto #13722]
The Yocto bug reports a few improvements in the gdbserver configuration
which makes the configuration of gdb easier for novice users.
(From yocto-docs rev: 48c96378fd5edd587025f3ca138bc5114e927f2f)
Signed-off-by: Sundeep KOKKONDA <sundeep.kokkonda@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Hardknott 3.3.6 is the last release of the series and the release is now
obsolete.
Let's remove hardknott from the list of active releases.
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 4ecce89b6a5d5feb0d31c735a39619e73eeb5e44)
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>
This prevented variables from being substituted through the
code in yocto-vars.py, at least in the files included this way.
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
(From yocto-docs rev: b7375ea4380e716a02c736e4231aaf7c1d868c6b)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Remove the reference to the GPL license, unnecessary
in this part of the manual and pointing to a wrong
link (LGPL instead of GPL).
Anyway, we have no authority to say that the MIT license
is compatible with the GPL.
Also provide details about the MIT license through Wikipedia,
instead of just the raw license text with no explanations
through opensource.org.
(From yocto-docs rev: a09fcd9d850d2b52f40d953b11412c9568a77db7)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This will allow the autobuilder-helper run-docs-build script to obtain
the latest release name.
(From yocto-docs rev: 733b7f301e44010579e1315f19eff737628d635e)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Uncomment langdale lines to bump the version.
(From yocto-docs rev: e0016979413ab27f2e5db88ae1de180507c759c2)
Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Bump various versions and names.
(From yocto-docs rev: 7c617e7e956696842c03a7b18baff931b72d70db)
Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(From yocto-docs rev: e814a998cc0a7c451a77df0304d0a69a27ac08ae)
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
If I am not mistaken, the only kernel recipe to have a new PACKAGECONFIG
option is linux-yocto-dev, in commit 1bac831fba
"linux-yocto-dev: introduce dt-validation PACKAGECONFIG".
Therefore, let's replace (kernel) by the one kernel recipe that has this
change.
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 1882954924cef9f17caad0f83973afe08f4db764)
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
It's RISC-V and not RiscV, c.f. https://riscv.org/ (yes, no dash in the
domain name...).
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 1a5fd51a50fe39d8095bb5a4f34d6b953e59c58f)
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Plaintext/clear passwords are not supported anymore but hashed passwords
still are. Mention that in the migration guide and point to the
appropriate location of documentation.
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: f8b9697ec7bcc188db5ce9e5067bc82c023b79d9)
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add examples for hashed hardcoded passwords from extrausers.bbclass so
that this feature is not hidden away.
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 5db73c7c5668144ed4629f95378e44f0bd8c8256)
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
extlinks captions support using %s substitution but only from sphinx 4.0
onwards.
c.f. https://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html#confval-extlinks
Weirdly enough, on older sphinx versions, the caption is just a prefix
to the actual text passed to the extlink. Therefore, in that specific
case, CVE- or CVE-%s are identical in meaning for sphinx >=4.0 and since
only CVE- caption works on sphinx <4.0, let's go with CVE- caption
prefix.
Fixes: b311070d866cf "manuals: add 3.4 and 3.4.1 release notes after migration information"
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: c9922076f5c1285d9cfd6aff8ce5b6635d88222f)
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
ZSTD_THREADS is new for kirkstone.
(From yocto-docs rev: b970936b89bebb184c82be3a9514a9eba7c04f9b)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
XZ_THREADS and XZ_MEMLIMIT were introduced in dunfell.
[RP improved an original patch from Paul]
(From yocto-docs rev: 96defb66b775093b5270bd1ebad0461c2bba1e5b)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Generated from commits in the kirkstone branch, as well as a few entries
from the migration guide.
(Note that the "Repositories / Downloads" section still needs to be
filled in.)
(From yocto-docs rev: 0c66638e61d3e16ac8d4b7ebc4ec6fb35625bf4f)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Make some corrections to preliminary set of entries
* Move out entries that were more appropriate for the release notes
(i.e. that are more additions rather than changes that require the
user to make changes)
* Add new entries based on commits in the kirkstone branch
(From yocto-docs rev: bea2da80e7c5338dc5abefe95ce27b80ed4ee98a)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This check is new in kirkstone.
(From yocto-docs rev: baa483e75538013be3261f8c115b8a5364b24c60)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
New variable in kirkstone.
(From yocto-docs rev: 2c5d4938a09fd35f9e86f682cde89d4693762725)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add this since the INCOMPATIBLE_LICENSE wildcard support has changed in
the 4.0 release.
(From yocto-docs rev: c7946863e5a9d62a49131b92cc9549da9b799bbd)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
It seems prudent to point out that hard-coding passwords in the manner
detailed in the example is not a good idea in production. This type of
mistake has unfortunately been made by many device vendors (outside of
the Yocto Project context) leading to security vulnerabilities.
(From yocto-docs rev: 1d07dba9423ae0a841eccb58c297e31b63c3965d)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
We missed noting this in 3.4 but I noticed the documentation was
recently updated, so note the removal.
(From yocto-docs rev: f661e62d6faf48dbb6c6fd9a61a6448ec339d2bf)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Branches can never be outdated so let's check the release is not a
branch (branches end with .999).
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 4755961bbb5f674a7532b91cca20ea44a1e22ae7)
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The switcher expects URL subpath to match the "release" used by sphinx
to build the documentation. Branches, however, are put in a subpath
after their name (e.g. dunfell) while sphinx sets the "release" to
X.Y.999. This means the switcher cannot replace correctly the path to
switch between releases/versions.
Let set_versions.py inject the list of release names into the
switchers.js.in file so it can check whether the subpath is one of the
release names in which case it needs to be stripped.
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 5ef3d129b8d0d8ae98a694103930988a46285525)
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This array only contains versions that can be selected through the
dropdown menu for switching between supported versions.
Therefore, let's rename it to switcher_versions to make its usecase
clearer.
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 5c3d67751bf3f572a0788d3a4734b80e3453d084)
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Branches are identified by their .999 version suffix which means they
will never be matched in the forloop above this git context. Therefore,
branches will match the condition. However, branches are not necessarily
obsolete (e.g. dunfell, honister and kirkstone today), so let's mark as
obsolete the branches which are from obsolete releases.
Old tags of currently supported releases are not defined as obsolete but
outdated, therefore using the series to which they belong like it is
done for branches is enough for obsolescence detection.
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 7181a432da18b47608784363d243ea39b80be1ed)
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
master branch of Bitbake is now located at docs.yoctoproject.org/dev
instead of docs.yoctoproject.org so let's update the switchers and
set_versions.py to reflect that change.
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 18338292d99ed236e2bac6e73a5152ef11c4a9e5)
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
ourseries can be an active release and therefore shouldn't be marked as
obsolete. By adding ourseries to activereleases, it is impossible to
know if ourseries is actually an active release or not. Instead let's
loop on the active releases with ourseries too (only if it's not active
release, otherwise it'd appear twice).
Fixes: 6f40ef56054ec "docs: set_versions.py: add information about obsolescence of a release"
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: f16b633211b97b2cdf2c65d83c99cd3853d2bb5c)
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
versions array is supposed to store the latest version of all active
releases. However, in the loop it is reassigned and therefore, the check
on whether our version is already in the versions array will always
return false (except for the latest version of the last active release)
and write our version again in the list.
By using a local variable for the logic instead of versions array, the
check now works properly.
Fixes: f2b069be8c307 "set_versions: Various improvements"
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 36a088c8c99dd37f5ca07ec8f90f2c51ef8b36f2)
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Based on additional information per release, specifically with the
obsolescence status of a release, the obsolescence detection can now be
much smarter than just checking if the release is older than dunfell.
This is required because with LTS (dunfell for example) releases, it is
now possible to have LTS releases that are older than obsolete releases.
This means obsolete releases need to be tracked and only the release
version cannot be used as an indicator of obsolescence.
Let's use the obsolete field of the per-release data in the all_versions
dictionary to display correct warning messages.
The warning message is first about outdated version if there's a newer
one available (*even* if it is for an obsolete release, e.g. 3.0.1 will
say it's outdated and should select 3.0.4 version instead), then if the
version is the last of the release, show a warning message if the
release is obsolete.
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 6986baa0d3b544bbad8a7e23ee447abc6f2769f6)
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This adds support for marking releases as obsolete to make the
detection algorithm smarter (in a later commit) than just checking if
it's older than dunfell.
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 6f40ef56054ecbd3d8b7310d748c1af78a689add)
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Since commit f2b069be8c307 "set_versions: Various improvements", an
outdated version will always appear in all_versions, meaning there'll
always be an exact match in the loop (just above the git context of this
patch) so there's no need to add the current_version to the dropdown
menu manually.
This issue showed up only for outdated versions of obsolete releases,
e.g. 3.2.3. In that case, 3.2.4 (latest version of the obsolete release)
will appear in the all_versions array in addition to 3.2.3, which means
the check on release series (3.2) will be matched twice, and 3.2.3 will
be printed once in the 3.2.4 loop because version != current_version and
once in the 3.2.3 because it is an exact match to an entry in
all_versions.
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 05065fa1f3855e8b7d9e8af0502b4ae402273400)
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Update the docs to reflect that kirkstone is 4.0, not 3.5.
(From yocto-docs rev: a6f571ad5b087385cad8765ed455c4b4eaeebca6)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Otherwise rendered as "en" dashes by sphinx, for example:
git pull –rebase
instead of
git pull --rebase
Readers could confuse them with normal dashes.
Exception: replace by \-\- in italic text (*text*)
as Sphinx cannot nest italic and quoted text.
For consistency, also update quoting in strings in the same code hunks.
(From yocto-docs rev: 4e7ce372e37f76148f623a5295a15e08bc2603ff)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add the list of renamed and removed variables, show how the renaming
script works. Also mention the change in cve-check output.
(From yocto-docs rev: a0b55789035c8d44426b6ff8267b4042ef0a58ba)
Signed-off-by: Marta Rybczynska <marta.rybczynska@huawei.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The AVAILABLE_LICENSES variable has been removed from OE-Core.
(From yocto-docs rev: dd687b10e1a21222e8dcc3be29635fd3200a205b)
Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add new PEP517_* variables, remove obsolete variables, and update for
renamed classes.
(From yocto-docs rev: 3984d4d0804125ba6fba7bf712edb81f97b4bec7)
Signed-off-by: Ross Burton <ross.burton@arm.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I believe we should only be showing the "active" versions in the switchers
base list of releases to show. Zeus and warrior are old and no longer actively
maintained and we don't suggest new users use them. gatesgarth is also
outside it's support window.
I therefore propose removing these leaving us with dev, honister, hardknott,
dunfell (LTS). In addition, any release that is selected will be shown, along
with any later release in that release series.
People can still navigate to the older docs using the releases list or by
direct URL but this highlights to users which releases we'd expect/encourage
them to be using.
(From yocto-docs rev: 5bcd6a632ba2ebace9c65fe8529f8f1de40226ce)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Build scripts now only require updates in master.
(From yocto-docs rev: af6a15e376733727eb26c9c2a6b6a85f6faea437)
Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Correct the previous commit since we need to compare against ourseries
rather than ourbranch since devbranch would match against the series,
not the branch.
(From yocto-docs rev: 57f5ce5fe427e5387f6ac85225137463e51e5643)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The dev branch is being displayed in switchers under two different
headings, 4.0.999 and dev (4.0). Add an additional conditional to fix that.
(From yocto-docs rev: 569815ac290f53a17330e53fb46c4870d8d247d2)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I believe we should only be showing the "active" versions in the switchers
base list of releases to show. Zeus and warrior are old and no longer actively
maintained and we don't suggest new users use them. gatesgarth is also
outside it's support window.
I therefore propose removing these leaving us with dev, honister, hardknott,
dunfell (LTS). In addition, any release that is selected will be shown, along
with any later release in that release series.
People can still navigate to the older docs using the releases list or by
direct URL but this highlights to users which releases we'd expect/encourage
them to be using.
(From yocto-docs rev: fdcdc50f3abf10aa702c958b8ba7ab6b19c57bff)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The dev branch is being displayed in switchers under two different
headings, 4.0.999 and dev (4.0). Add an additional conditional to fix that.
(From yocto-docs rev: 569815ac290f53a17330e53fb46c4870d8d247d2)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- Allow specifying the version from the commandline
- Add all previous release series/version mappings (to support transitions branch)
- Add poky mapping for 3.4 as some releases erronously use it
- Improve git branch 'guessing' code to work properly
- Handle poky '.0' release mappings correctly
- Only write poky.yaml if poky.yaml.in exists
- Ensure older non-active releases are shown in the switchers.js
release list.
- Ensure current version and current release series are shown in switcher.
(From yocto-docs rev: f2b069be8c307e3efe518f5d9bb1e6e705b96554)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
A horrible blunt hammer approach to updating the version information in
switchers.js based on the available tag information.
To merge and work correctly, this will need a change to the autobuilder-helper
docs generation code to pull the swicthers.js and script from master, then
to run the script. That should hopefully remove the need for other patching
even on old docs branches though.
(From yocto-docs rev: dc858c8b2ffdb792fe8cef05fab3d752aa858f78)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Allow conf.py to read the versions it needs from poky.yaml and have
set_versions.py write this out. This means we don't have to change as
many files when making new releases.
(From yocto-docs rev: bfe74c67f327f0c6445cb4129ee0c32db022b95a)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Use a script to generate the branch/tag information inside poky.yaml.
If the branch isn't a known release branch, include git magic to find
the closest matching release branch we know about.
(From yocto-docs rev: 841e2df0e2e544b82fff9ddd0339a4e775148e3a)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Adding 3.1.15 to documentation switcher and release list.
(From yocto-docs rev: 355dd1e3f5bf76244a0b5862475cb06ace1c87b9)
Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This doesn't seem to be used anymore and doesn't make much sense,
remove it.
(From yocto-docs rev: 89176e0bd45453ebb7ac77ce6fa333cb94f0cfcc)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
We don't publish tarballs using this version any more, it has been
removed everywhere. Remove the obsolete references in the docs,
adapting references accordingly. The tarballs now are just created
with their sha256 checksum which we don't want or need to reference
in the docs.
(From yocto-docs rev: c7a0ac88b01c48f3d9209536542bf43ae7a7937f)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
journald is not a syslog provider, so using journald exclusively amounts
to just preventing a syslog provider from being specified on a system
where journald is active.
Various spots where this has popped up:
* https://stackoverflow.com/q/48746397
* https://lists.yoctoproject.org/g/yocto/topic/82883035#53548
(From yocto-docs rev: aba38d5dc2db708ed6e8fc6dca4d869fe7fe855c)
Signed-off-by: Nicholas Sielicki <nicholas.sielicki@legrand.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
