To make it more obvious which directories are needed, pass only these to
*mkdir* and use the option `-p` to create the missing parents.
(From yocto-docs rev: 92806d2ab1f909eef9ccc532958a7ced6262b9b0)
Signed-off-by: Jörg Sommer <joerg.sommer@navimatix.de>
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
As reported by "make sphinx-lint"
(From yocto-docs rev: 7e8d8d6d47da61457798e90b1d53f3082fe76668)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
As reported by "make sphinx-lint"
(From yocto-docs rev: 1601bf2d294c3a8e7c4c654539c8a4da3ed054d0)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Makes it possible to catch errors not reported by sphinx,
such as idle spaces. After customization, this should be used
to enforce our syntax conventions, such as two spaces after a "-"
character to introduce a list item.
Just run "make sphinx-lint".
(From yocto-docs rev: 9e1aeeddca06cb7d65631010ba0eebdcd8ecf9ee)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
List systemd changes
Add PACKAGECONFIG-related changes, as well as systemd-boot-native, to
'Miscellaneous changes section'.
Mention the licensing changes in systemd and libsystemd.
Add changes to wic
Summarize changes in 'wic Image Creator enhancements' item.
Add Go language upgrade
There were multiple bumps between Scarthgap and Nanbield, but overall
the version was upgraded from 1.20.10 (in Nanbield) to 1.22.1 (in Scarthgap).
Mention the new class 'go-vendor' in 'Miscellaneous changes'.
Add create_go.py to script changes
Mention this new script, at recipetool, in 'Utility script changes'.
(From yocto-docs rev: 3e24a1cf2f2089beedad11b91fc11b8b402caf87)
Signed-off-by: Joao Marcos Costa <joaomarcos.costa@bootlin.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
List removed recipes
Fill the 'Removed recipes' section for the upcoming release 5.0
Leave some sections empty
Only mention that no classes were removed and no variables were removed in the
upcoming release 5.0.
List systemd changes
Mention the nss-resolve related changes.
Add Go language changes
List removed variables
Fill the 'Removed variables' section for the upcoming release 5.0
Add QEMU changes
Add Miscellaneous changes
(From yocto-docs rev: cbc0b6fa333984c0c49f3c94daffd496815b5d68)
Signed-off-by: Joao Marcos Costa <joaomarcos.costa@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
A reference to this class in the release notes will be added in a
follow-up commit.
(From yocto-docs rev: bfd38ad1056ded01a25acfa37e89302df2290ddf)
Signed-off-by: Joao Marcos Costa <joaomarcos.costa@bootlin.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(From yocto-docs rev: 26a94025d4ce445495e83565b4d53bda5b7aeef6)
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>
There's a new yocto-patches mailing list available for all layers that
do not have their own mailing list.
c.f. https://lists.yoctoproject.org/g/yocto/topic/105197684
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: ac512f76b93a20507a6835ddafa954b4ae45e268)
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>
reorder CVEs from alphabetical order to numerical order, align it
with text based release notes.
(From yocto-docs rev: da670cfe7c22ece8925cb620f52832cc1c34e736)
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>
Try to particularly emphasize that it can be used to find
out why something rebuilds when it shouldn't.
(From yocto-docs rev: cfaf2707b4a77888316d5eb24bf41ccc21e2c12b)
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>
They were separated in
https://git.yoctoproject.org/poky/commit/?id=63e53fb8b60d38315015844bd3357fa1649cd639
(From yocto-docs rev: b880ac9498764027de435103d493f34adf68dc13)
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>
The documentation of the variable SPDX_NAMESPACE_PREFIX does not exist.
This variable is used to change the prefix of some links in SPDX docs.
(From yocto-docs rev: 85c56d8f7f65875628ab63abf661705b26f55224)
Signed-off-by: BELOUARGA Mohamed <m.belouarga@technologyandstrategy.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
According to errors reported by "make stylecheck"
(From yocto-docs rev: fc808b2dca4321209bfa6206d9e43aa1a5a0c5b8)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Use the "Vale" (https://vale.sh) tool to perform text style checks
Run "make stylecheck" to run the checks.
This just checks the text, not the Sphinx syntax style choices.
(From yocto-docs rev: 51b1f9a4d5aa02d337b105633de38e18b923a13a)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Suggested-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* this is often confused to apply for e.g. meta-oe as well
where it doesn't apply as meta-oe has own ML mentioned
in README.
(From yocto-docs rev: 63be0814a7ecf38c570b6d776f62b7c7803eb299)
Signed-off-by: Martin Jansa <martin.jansa@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(From yocto-docs rev: 224de9dfb6238677ecff715e1d57376487b6517f)
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>
releases.rst is generated by the set_versions.py script
(From yocto-docs rev: 4b7773f59bab2d653d07b7e06cd21745b646b604)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Allowing to remove nested parentheses in the text!
(From yocto-docs rev: 7cfa49fe17a8a20a8d4671c0daf1820c3cd69952)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Instead of "manpage(s)" or "man page(s)".
To address one of the errors reported by "make stylecheck"
(From yocto-docs rev: 86f5f5cd385f09c48c4cf0b1ab222d6e1e7c7e54)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Plus a few text styling improvements, some reported by "make stylecheck"
(From yocto-docs rev: c29a1bf4dd5223e4af9c1be5a8a8ea6a88bb7a58)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Use the "Vale" (https://vale.sh) tool to perform text style checks
Run "make stylecheck" to run the checks.
This just checks the text, not the Sphinx syntax style choices.
(From yocto-docs rev: d145e1dc45dc0792c8b8f7e73500b56face1e710)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Suggested-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Cite usage of IMGCLASSES variable in class 'image' as found in OE-Core's
commit [1].
[1] 451363438d38 ("classes/recipes: Switch to use inherit_defer")
(From yocto-docs rev: 674f376ece98466d3498459d5b5428a8bfbd5112)
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>
What was previously known variously as Bmaptool, bmaptools, bmap-tool,
and/or bmap-tools has been updated to the singular name: bmaptool. Update
all references to suit.
Since we are not in charge of debian's package naming policy, any
references that relate to debian package(s) will stay as "bmap-tools".
(From yocto-docs rev: 9c1505eabd69af548652381cf996d44f40a4fa8a)
Signed-off-by: Trevor Woerner <twoerner@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Document the convention to use variables prefixed by VIRTUAL_RUNTIME.
Add references to the new term where possible.
Another reason is that such variables are recommended
in a warning issued by meta/classes-global/insane.bbclass
(From yocto-docs rev: 11e1ba97edac979868f199e43c1004db6678044c)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Tim Orling <ticotimo@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This adds some hints that and how changes should be tested when contributing.
Fixes [YOCTO #15412]
(From yocto-docs rev: 6f3dbb2a909ba5b71efb09b251ee3f8650e30146)
Signed-off-by: Simone Weiß <simone.p.weiss@posteo.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Using "PR service" instead of "PR Service", like in the other
two instances in this document.
(From yocto-docs rev: f1061014dff7732fe97866dbd9208f09dcde56dc)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Reviewed-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add missing documentation on how to add multiple groups with a single
GROUPADD_PARAM:${PN}
(From yocto-docs rev: e55d2aa6a0ee58ee980de2a6ca8d531c7c0cd44a)
Signed-off-by: Geoff Parker <geoffrey.parker@arthrex.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The SDKPATH variable seems mistakenly identified as the
default path where the SDK will be installed by the generated
installation script, unless option '-d' or a manual input
overrides this default.
The intended variable is SDKPATHINSTALL. SDKPATH indicates
where the SDK is being composed and built.
The definitions have been added/updated.
(From yocto-docs rev: d5b9c4b9c443cc728a11fd1e0a26a11aac8ee2c5)
Signed-off-by: Johan Bezem <jbezem.extern@arri.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
do_cleansstat can produce build errors when using a shared sstate cache.
Add a note to clearly discourage, provide a safe alternative (bitbake -f),
and the rationale.
Suggested-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Link: https://lore.kernel.org/yocto-docs/20240219155513.76738-1-luca.ceresoli@bootlin.com/T/#m5529687ecb0f9ec2dacddcb6ff58e2df73af9cde
(From yocto-docs rev: 6fb06bb4a917c1515e54fa3e699119f6bbb85767)
Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
Reviewed-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
do_cleanall can produce failures when used in legitimate cases, such as
with recipe variants (foo and foo-native) or a shared DL_DIR. This is why
it is forbidden when writing tests that will run on the autobuilders
(https://docs.yoctoproject.org/test-manual/intro.html?highlight=cleanall#considerations-when-writing-tests).
Reword the documentation to clearly discourage, provide a safe alternative
(bitbake -f -c fetch), and the rationale with an example.
Reported-by: Sam Liddicott
Link: https://bootlin.com/blog/yocto-sharing-the-sstate-cache-and-download-directories/#comment-2650335
(From yocto-docs rev: bfeb00f9213b9d2650ccf03ea666387415227be4)
Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
Reviewed-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
With a new check was added for oe.qa for CVE_STATUS via commit
3c5b7605acd9cd68b ("cve-check: Log if CVE_STATUS set but not
reported for component")
in poky. Add related documentation here.
(From yocto-docs rev: 04e1ff01e1b43daa0e5832904a82f95d0cfab678)
Signed-off-by: Simone Weiß <simone.p.weiss@posteo.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Enough free storage space is needed to apply package upgrades.
(From yocto-docs rev: 6571eb02cbd5c2b96df0f279f25b63255ab7eac4)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Explicit the problems previous described as "obvious".
(From yocto-docs rev: ca939f9ceebbf9b5e82bb76abf1c4d20f039d68e)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Suggested-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Cover the new devtool ide plugin in the extensible sdk section.
Many thanks to Enguerrand de Ribaucourt for his re-view and
contributions.
(From yocto-docs rev: d318cc41e0600ca8e18bc6789cac414ae0226a07)
Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com>
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
PYTHON_PN is on its way out, therefore it's good to remove it from
documentation so its use is not promoted anymore.
(From yocto-docs rev: 74180c0f6bcdeadbd6f9a69d26f733c716f420fd)
Signed-off-by: Khem Raj <raj.khem@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(From yocto-docs rev: 89403af3fa49ecb00dfec04ac9c490b6dc031008)
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>
To simplify the style, replace "Following is" and "Following are"
by "here is" and "here are", sounding more natural.
In some cases, also go further by simplifying "Here are/is xxx"
by "xxx are/is" when the "are" or "is" are not two far at
the end of the sentence.
In some cases too, completely remove the sentence, when
it's redundant with the preceding title.
(From yocto-docs rev: 52ba6bb16c73cbc2c0e77496d5226c49bce786f5)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Daniel Ammann <daniel.ammann@bytesatwork.ch>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- "git" is now required to run "set_versions.py"
- Fix Ubuntu / Debian packages.
The previous instructions didn't run on Debian 12
Tested on Ubuntu 22.04 and Debian 12.
Reported on https://lists.yoctoproject.org/g/docs/message/4789
(From yocto-docs rev: cd0525f1a081567d5d8722d368511179655ca541)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: <mhagans@skyviewsat.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Make the options more clear by providing them in a list instead of plain prosa.
Also add a ref for a presentation wrt spdx 3.0 in the Yocto project.
Fixes [YOCTO 7476]
(From yocto-docs rev: a15e354f98607592a67d2df91dfa2bf0707d8f38)
Signed-off-by: Simone Weiß <simone.p.weiss@posteo.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This fixes an ugly formatting issue in the HTML output
(From yocto-docs rev: 79530aeb97976b9a63bf04ed247f98061fc9d737)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This fixes an issue introduced by d8fdec653f96c4ddcb705ff0ef17ed641afcfe2d
(From yocto-docs rev: bd970a2101df6e7437fce9cd74deb8bb86aedbd0)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
