The text format has been removed, so also remove references and examples
using this format. Replace with examples with the JSON format.
(From yocto-docs rev: 3757ace0581e6279aa7c065b21cee56edfe985dd)
Signed-off-by: Marta Rybczynska <marta.rybczynska@ygreky.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit a52cd7bcadccc53e982f90d6e170d00798322597)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
In the same fashion as the previous commit ("ref-manual/packages: move
ptest section to the test-manual"), move the runtime testing section of
the development tasks manual to the test environment manual.
Add a link to it from the test-manual/intro document.
(From yocto-docs rev: 79aa34db34def525a11c41d951365bcb891318c4)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 6b44257874858db3aa426d3e84a79c41cb4937a3)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
[ YOCTO #15106 ]
It makes more sense to document ptests in the test-manual. Since ptests
are still related to packages, keep a link to ptests from packages.rst
to the test-manual.
Reported-by: Yoann Congal <yoann.congal@smile.fr>
(From yocto-docs rev: 110e15c4407dfc03c7d931e4488eb43dbfad7570)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit b389c06b709e4791e1cce5e8a5b58f6b0cd03a14)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
The previous bin_package description was confusing: it would instruct to
use the git fetcher to extract the content of an RPM package using the
`subpath` option - but that's not possible as the git fetcher can be
used to clone a repository but not to do the extraction.
Update the description by telling what it really does and what it
doesn't do, and by giving an HTTPS+RPM example.
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 13c9f861547490a734a7e6396ac0b8f416863f70)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 305f024bf99ba02b153eed0cebe3d36594868497)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
These are not distinct anymore and check for any patches in any layer.
(From yocto-docs rev: a27e4c426bfb039c9a2a4b7971a74c1fc05e6274)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 300c585909743754e0e6662d48d43834c031b835)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
Document the change in behaviour in 5.0.
(From yocto-docs rev: f7a223d4e78bee67107fa47e147208f57a2d9521)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add brief documentation of python_maturin and python_mesonpy classes
that were added in 5.0.
(From yocto-docs rev: ce7dd61a928dec778a5df538701dfdeb26db0ebd)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add the new virtual-slash QA check to the insane class section and the
QA checks section.
(From yocto-docs rev: fdca0217558185eca67f7ec04b9d282b7819d107)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
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>
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>
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>
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>
UBOOT_CONFIG accepts a third parameter for the UBOOT_BINARY that isn't
documented. To show its usage another example from the meta-freescale layer
was picked.
(From yocto-docs rev: 8b227582efbe9957026cdce4aef5621661af1fa5)
Signed-off-by: Jörg Sommer <joerg.sommer@navimatix.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
insserv.bbclass was removed from oe-core:
commit e6bb5dbb62
Author: Richard Purdie <richard.purdie@linuxfoundation.org>
Date: Sun May 10 12:30:49 2015 +0100
insserv: Remove
(From yocto-docs rev: 41a15a80a325cb63a41be81e632ec2799bfb2957)
Signed-off-by: Maxin John <maxin.john@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Deprecate CVE_CHECK_IGNORE with CVE_STATUS
(From yocto-docs rev: 8b8054977f31e2d6090521a0102f066b6d563733)
Signed-off-by: Andrej Valek <andrej.valek@siemens.com>
Signed-off-by: Peter Marko <peter.marko@siemens.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This sentence was originally written based on the comments in the .bbclass
file, but further editing led to saying the same thing twice. Remove the
duplication and also reword it to make it generally better.
Fixes: f65816f5ea62 ("ref-manual: classes.rst: document devicetree.bbclass")
Reported-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
(From yocto-docs rev: cbacc8a77aca68c5b25c8cad42bc4c88275cfc09)
Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- Document the new KERNEL_DTBDEST and KERNEL_DTBVENDORED variables
- Also document the related KERNEL_DEVICETREE_BUNDLE
and KERNEL_PACKAGE_NAME variables
(From yocto-docs rev: 19f128e725da35234ec2c234c667ee7ff3d67d8d)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(From yocto-docs rev: 221bcf2e32fb42b6527ff0b4cfe0c4591ab89f78)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Jamin Lin <jamin_lin@aspeedtech.com>
CC: Sean Anderson <sean.anderson@seco.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- Mentioning that they are related to this class
(for further information about their usage)
- Replace "fitImage" by "FIT image"
- Minor formating and style fixes
(From yocto-docs rev: 07214a4ff2646efb143a02fc9381a029870e9b56)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Jamin Lin <jamin_lin@aspeedtech.com>
Reviewed-by: Sean Anderson <sean.anderson@seco.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Document the newly added DT_FILES variable and closely related
DT_FILES_PATH. Also add DT_PADDING_SIZE to the glossary.
(From yocto-docs rev: 8f3f187e2353c718c6fb4e224d13ba559ad2f85b)
Signed-off-by: Petr Kubizňák <kubiznak@2n.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Since a very long time the kernel bbclass uses a defconfig file from
SRC_URI automatically. Document this feature.
(From yocto-docs rev: 220b25d7d47d46b0d85c616b88ead75fab917092)
Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
"This means that" implies that this sentence is a consequence of the
previous, but this is not the case, the two sentences being quite unrelated
to each other.
(From yocto-docs rev: 1f352ad21bb892e74bdb46aee791d0f86b150249)
Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This section needs to be kept in sync with the "QA Error and Warning
Messages" section (qa-checks.rst) - this is the other direction that
tells folks what all of the values in WARN_QA / ERROR_QA are intended
to do. Add the ones that we missed adding here for previous releases,
and also use a proper reference for the buildhistory class in the entry
for version-going-backwards.
(From yocto-docs rev: 356a6e650bb1de66b806142f75a03bda57972a94)
Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This has been removed in 4.2.
(From yocto-docs rev: a5dcaf95915deec5243ab2fd0711c63e98b2a661)
Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
To make it possible to add more examples (CMake, Meson, Go, Rust...)
- Change section title names
- Adjust paragraph line length
- Have the Autotools example after the one with a custom Makefile,
corresponding to an increasing level of complexity.
- Clarify that GNU make and the Autotools are used to build
the applications, not by these applications.
(From yocto-docs rev: 6f313e673fe4d2878c8166619c27c4958af73615)
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>
Now that .bbclass is removed from class section titles.
We can now have, for example, :ref:`ref-classes-insane`
instead of :ref:`insane <ref-classes-insane>`.
Then, when necessary, rework paragraphs so that they
have lines of even length, not exceeding 80 characters.
(From yocto-docs rev: e76190e3be78c1e483bec0469f1e437dbf8f3791)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Suggested-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This is unnecessary and allows to simplify the references
to such sections, most of which are removing the .bbclass extension
anyway, for example in :ref:`insane <ref-classes-insane>`.
(From yocto-docs rev: 44fbdb909c47553fecb7f9eb37f065a8768bc922)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Suggested-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
