Remove a reference to a web resource which is clearly marked as obsolete.
Replace the unnecessarily verbose note by just links to the mentioned tools.
[YOCTO #15233]
(From yocto-docs rev: f7e57707a08a9a86ea146722e481ef2e7f362277)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
Recommended instead of the Yocto Project mirror, because expected
to be faster. Make sure you only set one such mirror.
(From yocto-docs rev: fbf020e19a47b4a4bf6c4f12ecabab6fce572d66)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: richard.purdie@linuxfoundation.org
Signed-off-by: Steve Sakoman <steve@sakoman.com>
As discussed before with Richard Purdie, the code supports this but the documentation does not.
Developers in general will not notice this or focus on it because they do not mess with the
layer.conf template file, but in my opinion I think more details can help.
(From yocto-docs rev: 635b198dfeb8147728a610b710fbc8ce77859389)
Signed-off-by: Talel BELHAJSALEM <bhstalel@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
COMPATIBLE_MACHINE is used to forbid the use of a recipe or its packages
for a specific set of machines.
In some cases, it may make more sense to have the logic inverted and
have the recipe always forbidden except for hand-picked machines. Such
could be the case for pieces of software that only support some
architectures. In that scenario, it is sometimes a bit easier on the eye
and for maintenance to use the OVERRIDES mechanism but for that, a
default should be set.
COMPATIBLE_MACHINE:aarch64 = "^(aarch64)$"
COMPATIBLE_MACHINE:mips64 = "^(mips64)$"
wouldn't do much because if COMPATIBLE_MACHINE isn't set, the recipe is
assumed compatible and therefore, if no default is provided we enter
that case.
Hence, we need to add
COMPATIBLE_MACHINE = "^$"
as default so that it only matches the empty string, which isn't
possible for MACHINEOVERRIDES.
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 051f868d1da1cbcd5726eb4c1e3f25946ce690e3)
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
Various aesthetic cleanups of section 1 of that manual, including:
* replace 'HOWTO' with manual
* add more examples of sdk-related images
* font fixes
(From yocto-docs rev: 55ce55247ab3238d69c165a01da1689158d8967a)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
PACKAGECONFIG's first and second flag value will be added to PACKAGECONFIG_CONFARGS
and then it will be added to the appropriate variable (EXTRA_OECMAKE, or ...)
So we need to only mention PACKAGECONFIG_CONFARGS and it will lead to other variables.
I added a custom example that can help understanding very well PACKAGECONFIG.
(From yocto-docs rev: 1bf0ac5c208d2d9609649bae681f37e3b4281c63)
Signed-off-by: Talel BELHAJSALEM <bhstalel@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
Add missing parenthesis, and another example of a compressed patch filename.
(From yocto-docs rev: 3b770bd5699706f7b843d579cb6a8ba796a3e54e)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
Adds an additional note about some of the side effects that can occur if
recipes are not reproducible and hash equivalence is enabled.
(From yocto-docs rev: 968ac9807466df775f18fca050070170d3ed8585)
Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
The proper way to inherit the testimage class is now
IMAGE_CLASSES += "testimage"
so change lines with 'INHERIT += "testimage"' to match. This makes the
dev-manual consistent with the migration guide, which already specifies
that the old way causes an error.
(From yocto-docs rev: 4d660551a6547ffe216e53402759baef424c4da2)
Signed-off-by: Trevor Gamblin <tgamblin@baylibre.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
This is in accordance with the gatesgarth Release Notes:
> In the ``Upstream-Status`` header convention for patches,
> ``Accepted`` has | been replaced with ``Backport`` as these almost
> always mean the same thing i.e. the patch is already upstream and
> may need to be removed in a future recipe upgrade. If you are adding
> these headers to your own patches then use Backport to indicate that
> the patch has been sent upstream.
<https://docs.yoctoproject.org/migration-guides/migration-3.2.html#miscellaneous-changes>
Suggested-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
(From yocto-docs rev: ca3fa9079f0effc8506626fc2c76736b240d2c29)
Signed-off-by: Roland Hieber <rhi@pengutronix.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
It was never really clear what all those reasons really meant, and every
patch submitted upstream liftens the maintenance on the Yocto side.
So remove the current list, and replace it with two reasons in which an
upstream submission likely won't benefit the upstream project.
Suggested-by: Alexander Kanavin <alex.kanavin@gmail.com>
(From yocto-docs rev: 3b2211e56220319f8134bfda2e9dc51376623173)
Signed-off-by: Roland Hieber <rhi@pengutronix.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
This was previously included in the OpenEmbedded wiki page [1], but was
not ported along with the rest in commit 95c9a1e1e78bbfb82ade
(2023-09-12, Michael Opdenacker: "contributor-guide: recipe-style-guide:
add Upstream-Status").
[1]: https://www.openembedded.org/index.php?title=Commit_Patch_Message_Guidelines&oldid=10935
Group the examples in their own sections (but name it differently from
any other section in this document so that sphinx doesn't generate a
warning about duplicate labels).
(From yocto-docs rev: f22254dcfe0f17cc7998a7cfc69dfc055b41e2f0)
Signed-off-by: Roland Hieber <rhi@pengutronix.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
Whilst often referred to as packages by people we should use the more
accurate term in documentation, 'recipe' instead of 'packages'.
(From yocto-docs rev: b164d45594bc054e96af7e64efae7e4fe685cec3)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
This document was suggesting a way to version pre-releases
which doesn't match the latest recommendations from the
contributor guide.
(From yocto-docs rev: bb74a9f83b84fa0d2836ed09175cac3c671b1042)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
Replace "duplicate" by "obsolete", more appropriate.
"duplicate" probably comes from the "--remove-duplicated"
option of the sstate-cache-management.sh script.
Improve other sentences too.
(From yocto-docs rev: e893d66999a97732780ff2b1ba6fb7e6e9d2eff7)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Richard Purdie <richard.purdie@linuxfoundation.org>
CC: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
Take advantage of this edit to also fix alignment
issues in the sources.
(From yocto-docs rev: 6d17f91c3078b5aeb6fa4acab8c9a0ff8e962fa5)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
":term:`Initramfs`" in bold text appears verbatim (no link is created).
The term link is present elsewhere in the text so remove the extra
markup.
(From yocto-docs rev: fc8e220290414dab45299d0ac829c8c461b1903c)
Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
- Update according to changes in SANITY_TESTED_DISTROS
(meta-poky/conf/distro/poky.conf)
- No longer declare as "Supported" the distributions versions
which are End of Life for their vendors, as some of them
(Ubuntu for example) ship updates to subscribers only,
which the Yocto Project has no access to.
- List distribution versions which were previously tested
for the branch of the Yocto Project being considered.
(From yocto-docs rev: fd5113b7e20844a44a2c9da37e1bc10034d46cfe)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
Requirements list seems to be outdated. It is not possible to follow
instructions for Raw Mode as not all of the native tools are available.
All wic dependencies are gathered under wic-tools package. Some commands
in the instruction already use wic-tools native sysroot, but this
dependency is not specified in the requirements.
Update the command for building native tools to use wic-tools instead
of the seperate packages.
(From yocto-docs rev: 8e6752a9e55d16f3713e248b37f9d4d2745a2375)
Signed-off-by: Daniel Semkowicz <dse@thaumatec.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
This has been around without being properly documented since 2019 (!!!),
and is nowadays the preferred method for enforcing license restrictions,
especially since meta-gplv2 is officially obsolete.
(From yocto-docs rev: 40d3cb5257fea3669efe28e534e5f9479a2837b3)
Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
- Kirkstone is now a 4 year LTS
- Add future Scarthgap LTS
- Update document metadata: license, title
(From yocto-docs rev: 408b722ca330155e770262c7db8494ff897cfdb1)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
It's meta-openembedded and not meta-openbedded, let's fix it.
Fixes: de6e7c05fbcf ("manuals: stop referring to the meta-openembedded repo from GitHub")
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 54d849d259a332389beea159d789f8fa92871475)
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
The references to the target and host systems (i.e. the client and
server respectively) were swapped in the instructions.
Also, there's no need to specify the device node on the server command
line that is run on the host system.
The previous, incorrect, instructions resulted typically in:
target# blktrace -l /dev/mmcblk1
server: waiting for connections...
and
host$ blktrace -d /dev/mmcblk2 -h target
Invalid path /dev/mmcblk2 specified: 2/No such file or directory
unless the same device node happened to exist on the host system.
Based on
target# blktrace --version
blktrace version 2.0.0
and
host$ blktrace --version
blktrace version 2.0.0
(From yocto-docs rev: 3534c2898ce835a08e200f50412561dc782e9021)
Signed-off-by: Hannu Lounento <hannu.lounento@vaisala.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
