There's no need to differentiate crediting contributors from committing
your changes, so let's simply make it the last step of "Commit your
changes" section.
This simply indents the text so it's now part of "Commit your changes"
list instead of the main list in the "Implement and commit changes"
section. Because of this reorganisation, the instruction to use "git
commit --amend" to add the contributors is moved to a note, and the
first few sentences are reworded to better match the wording of other
items in the "Commit your changes" list of instructions.
(From yocto-docs rev: eff4d14e28d323ebfdaeb0c5c805b5f1e2ad153d)
Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
... so that it's clear that you need to read and follow each and every
instruction in this list.
(From yocto-docs rev: c628a489f081925fabaabb5acac6752251150269)
Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This should hopefully make it clearer what is expected from the
contributor.
This follows my understanding of git-commit(1)[1] where the following is
a git commit message:
"""
git commit title
git commit description
"""
I'm putting the "Fixes [YOCTO" line in "body of the commit message" so
it's understood as being different from the git commit description so
that the note admonition allowing us to have an empty commit description
doesn't apply to the "Fixes [YOCTO" line.
[1] https://www.man7.org/linux/man-pages/man1/git-commit.1.html#DISCUSSION
(From yocto-docs rev: b84903a760350bd118c56ea9ce4e98039edf6e55)
Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The other tag descriptions have the double colon outside of the
highlight, and start the sentence with a lowercase word, so let's align
the CC tag with those.
(From yocto-docs rev: f116e93fb335e9d0f85891c4cb501bcf55b18ccf)
Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The example could be understood as the content of the commit message
once the editor (git config core.editor) opens, where the first
line is the actual commit title and not the commit description.
This example would make the Fixes line the commit title, which is not
what we want.
In short, according to my understanding of git-commit(1):
The following is a git commit message:
"""
git commit title
git commit description
"""
Reported-by: Barne Carstensen <barne.carstensen@danfoss.com>
(From yocto-docs rev: a5862406bf3230befe9db9f2539bbbc86c02015d)
Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I don't know what was the initial intent but this doesn't seem right, so
let's remove the bold formatting.
Fixes: 4abe87cb20d3 ("contributor-guide: submit-changes: detail commit and patch creation")
Cc: Michael Opdenacker <michael.opdenacker@rootcommit.com>
(From yocto-docs rev: 6c499b3796a578a0fe4c319c9547b4321b0d41df)
Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Extend the description of PERSISTENT_DIR to mention that it should not
be shared between builds. Add a note on sharing the hash equivalence
database by setting up a server and not sharing the file in this
directory.
[YOCTO #15727]
(From yocto-docs rev: 0ff0233770b77f9e74f4241dfb555dac2741d8b9)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
It is the libsoup-2.4 recipe that has been removed, not libsoup.
Also add that it has been moved to meta-oe.
(From yocto-docs rev: ac2896c89df7e5dfa91b18a5e1681019f17182d3)
Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This has changed since commit ed4238487c81 ("testexport: Fix to work as
an image class") in OE-Core.
[Antonin Godard: mention oecore commit in commit body]
(From yocto-docs rev: 2caa8e581feaf3640bea68108f9a02583b17b21b)
Signed-off-by: Barne Carstensen <barne.carstensen@danfoss.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add a migration note on the pni-names default policy change after commit
9b34a810496f ("systemd: stop enabling non-standard "mac" policy when
using the 'pni-names' DISTRO_FEATURE") in OE-Core.
Cc: Koen Kooi <koen.kooi@oss.qualcomm.com>
Cc: Ross Burton <Ross.Burton@arm.com>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 237f28de0bf8d1e1be60a0d9429b3a98740778e9)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
After commit 47533f20a7ec ("wic: rename wks flag --extra-space to
--extra-filesystem-space") in openembedded-core, document the
renaming of the Wic-specific option extra-space to
extra-filesystem-space.
CC: Alexander Kanavin <alex.kanavin@gmail.com>
(From yocto-docs rev: d3a34e8dca3c774234d3c6f4e575858869a7460d)
Signed-off-by: Pierre-Loup GOSSE <pierre-loup.gosse@smile.fr>
Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
After commits 47533f20a7ec ("wic: rename wks flag --extra-space to
--extra-filesystem-space") and c7f51c23fd268 ("wic: add
--extra-partition-space option to set unused space") in openembedded-core,
document the new Wic-specific option extra-partition-space and rename
the extra-space option to extra-filesystem-space.
CC: Alexander Kanavin <alex.kanavin@gmail.com>
(From yocto-docs rev: cba5dbb32a24c9e20e5a6066ec382cf7ff9b93e2)
Signed-off-by: Pierre-Loup GOSSE <pierre-loup.gosse@smile.fr>
Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There's a (second) overhead factor applied in images generated with Wic,
and this is already documented in the .wks reference. However, the
IMAGE_OVERHEAD_FACTOR entry does not mention it, and by looking at the
partition sizes (e.g. with parted) one may find it confusing that they
don't match with the expected rootfs size (e.g. in a scenario where the
extra space is "0" and IMAGE_OVERHEAD_FACTOR="1.0").
This second overhead is already documented, though:
https://docs.yoctoproject.org/ref-manual/kickstart.html#command-part-or-partition
Mention the '--overhead-factor' option in the glossary entry and add a
reference to the wks documentation.
(From yocto-docs rev: b9040e20b015e9b02683ec3014e4ade5eb59d41a)
Signed-off-by: Joao Marcos Costa <joaomarcos.costa@bootlin.com>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The filename is outdated as its version was already bumped and there are
also different files for different feed choices.
Use glob to match any available file.
Also the directory changed to CVE_CHECK2 meanwhile, so Update it, too.
(From yocto-docs rev: a2f18cb23183401d9d8e2fd4499d164ef8d86e44)
Signed-off-by: Peter Marko <peter.marko@siemens.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Update mailing lists following changes by Michael Halstead
(https://lists.yoctoproject.org/g/yocto-security/message/1478).
Also fix formatting/spacing.
(From yocto-docs rev: 8066aa92a1acae6c99fbee92d24ee1feea65d974)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
After commit c9585bb8689b ("Revert "qemux86-64: Reduce tuning to
core2-64"") in OE-Core, document the QEMU x86 micro-architecture level
bump in the release notes for 5.3.
Co-authored-by: Alexander Kanavin <alex.kanavin@gmail.com>
(From yocto-docs rev: 22c0fc1943c23d6f927034afdfa25ce64c5ba79a)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Increase the minimum size requirement to 140G, after running a build
with distro Poky. The size after rm_work has increase of only 1G, so
leave the current value for MIN_DISK_SPACE_RM_WORK.
Also, update the comment to mention that this is for distro Poky. It was
mentioned in commit message 285ba689ce3a ("manuals: update disk space
requirements"), but not in the comment here.
(From yocto-docs rev: dbc6137cd13f982a7fd4d1b2df79dccb177db0fc)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
documentation/scripts/check-glossaries returns:
WARNING: ref-manual/variables.rst: The variable EFI_PROVIDER shouldn't be in the glossary.
WARNING: ref-manual/variables.rst: The variable ZSTD_THREADS shouldn't be in the glossary.
(From yocto-docs rev: 4d3952414d109f9c9ebb029f3e20018664eacc86)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The checks rule can be run to perform some checks on the docs.
For now it only includes running the check-glossaries script.
This rule should only run basic checks or should not prevent the user
from building the docs in case of failure.
This rule can be used in the future to run additional checks on the
documentation.
(From yocto-docs rev: 1d9a4a52fa9f2e2eb7f282324f85a46b28128fbf)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Instead of tracking the glossary manually, add a small script that
checks if it is properly sorted.
Add two comments between the start and end of the glossary for the
script to know where it's located.
The script also checks if the variables are properly sorted. It uses
difflib and returns the diff if there's a difference between the
unsorted and sorted list.
Messages beginning with "WARNING:" are reported by the Autobuilder,
which is the reason for this format.
(From yocto-docs rev: 416d50c0c322eb88bf13353a198db7211e4d665a)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Update the release notes and migration manual for 5.3.
This covers commits from c4a5e590b5 ("rust-llvm: Compile llvm to use
dynamic libraries") to 2a832e6af1 ("orc: set CVE_PRODUCT") in Poky.
(From yocto-docs rev: c8d852ad63219d067e497a77d489a4011b0d0a26)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Since commit 24772dd2ae6c ("parse/ConfHandler: Add warning for
deprecated whitespace usage") in BitBake, a warning is printed when
there are no spaces around an `=` assignment.
Adjust the documentation to show good examples only.
(From yocto-docs rev: 77ce1544dd793036b1135817c02e090138fe6407)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
After commit 24772dd2ae6c ("parse/ConfHandler: Add warning for
deprecated whitespace usage") in BitBake, a warning is printed is
there's a missing space around an equal assignment in recipes.
Add a qa-check entry to qa-checks.rst.
(From yocto-docs rev: da2e9d45a4c70c5d78d225277a85cc4173e4ee7a)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Link to the updated qa-checks document that contains the entire list of
checks. The insane class was recently updated to remove all its checks
description and move them to qa-checks.rst.
(From yocto-docs rev: 0fcd1a352ae364bee191e7d160b2fec35431fcfd)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
WIC plugins were renamed after commit 2de444fc3ef4 ("wic: plugins source
bootimage/isoimage rename to allow be imported") in OE-Core. They no
longer contain dashes, but underscores.
(From yocto-docs rev: 7224d7733e9e0f423475e1b9c5b48aff0de1f744)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This class has been in OE-Core for a while but never documented in the
reference manual. Add some description for it and link to the existing
documentation on it.
(From yocto-docs rev: 362a331255525fc853dab3af4ec905c417fabb0b)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added by commit c0fa3d92cefa ("spdx30: Allow VEX Justification to be
configurable") in OE-Core.
(From yocto-docs rev: cee3eb30cc736d990f2232ede0bc6d9686a63713)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added by commit 34bb889ffaae ("classes/go-mod-update-modules: add class
to generate module list") in OE-Core.
(From yocto-docs rev: b1a9848d2bba9e1392d153ff992304b83b259318)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This variable is part of uboot-sign but not documented.
(From yocto-docs rev: 05eb461cb1da76ad9cbaf634da7f47447b3f6765)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added by commit 8e741b2e885a ("ast/BBHandler: Add support for
BB_DEFER_BBCLASSES") in BitBake.
(From yocto-docs rev: bf3c2ade55e4d90dd50f39d01405352cd48c1703)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added by commit 7892ee3dc37d ("kernel-fitimage: allow overriding FIT
configuration prefix") in OE-Core, but never documented.
(From yocto-docs rev: 860891492b96eb127af5e7bab6348fca12167c68)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Dropped by commit ecf8c386cf83 ("classes/recipes-devtools: Drop icecc
from OE-Core") in OE-Core.
Remove documentation for the class and the related variables. Remove the
references to this class.
(From yocto-docs rev: 30c9413c5106bcbcc1600ef16b8d0cece86d8158)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added by commit 2502da81709f ("bitbake.conf/pseudo: Switch from
exclusion list to inclusion list") in OE-Core.
(From yocto-docs rev: 5fc49ee007d22c7dc28c11ea579c804881b9cb8f)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The TESTSDK_SUITES variable can be used to control the list of test
modules run with the testsdk class.
(From yocto-docs rev: fbc6db0ab525c7e46774c01fc595f30d6d0fe3c1)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The KMETA_CONFIG_FEATURES variable defines kernel-yocto features to
enable.
(From yocto-docs rev: 1a9f68b875a78c1c7681ed300111399de97631e6)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Document the do_recipe_qa task in classes.rst and link to the insane
class documentation.
(From yocto-docs rev: d3f172b600413b58ee51c70e9dd4f69b32fdc5f8)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add a small document to describe how to start a Hash Equivalence server
with bitbake-hashserv, the reference server provided by BitBake.
Update reference to hash equivalence in other places in the
documentation to mention this document.
Move the note from the concepts document to the new document, as a
warning note.
[YOCTO #15921]
(From yocto-docs rev: 4ff998336efdc507de1311e43bf8f4a6258c610a)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Update the distributions to match the list of workers on the
Autobuilder. This list was generated with the help of
yocto-autobuilder-helper/scripts/yocto-supported-distros.
Also:
- Sort the lists alphabetically.
- Decrease spacing between entries for readability.
- Remove older Ubuntu distributions that are not tested on the
Autobuilder anymore.
- Fill the second list with EOL distros still running on the
Autobuilder.
- Empty the third list as it does not make sense to maitain on the
master branch.
(From yocto-docs rev: 56a7e8c209e804896558d759525d0c0317ac0ff5)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There was duplication between qa-checks.rst and the doc for the insane
class, so move all of the QA checks in this qa-checks.rst. Remove the
documentation for these checks from classes.rst and link to the
qa-checks.rst document from there.
For QA checks that were only documented only in classes.rst, add them to
qa-checks.rst.
Also sort qa-checks by their names in qa-checks.rst.
(From yocto-docs rev: dc984e5f54c38748603243053fde8b4d078ba586)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This was dropped by commit 452e605b55ad ("cve-check: annotate CVEs
during analysis").
(From yocto-docs rev: 55aedec94dce3e3c0541ffaea666cff02d63a708)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Document the new classes under classes/toolchain as well as
PREFERRED_TOOLCHAIN* and TOOLCHAIN variables, which allow selecting the
toolchain. For now there's "gcc" and "clang" as available toolchain.
(From yocto-docs rev: 69a9568f8bd7ed57efddab507a4294ad3408f4dd)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The tar packaging format was removed some time ago. Also, add some
minor grammatical tweaking.
(From yocto-docs rev: 8e9fd1ca232f3c1e8be51cb881a68b4745ee548a)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
After compact vsdisk you have to detach it before exiting
otherwise the vdisk remains attached.
DISKPART> select vdisk file="<path_to_VHDX_file>"
DISKPART> attach vdisk readonly
DISKPART> compact vdisk
DISKPART> detach <------------ new missing command
DISKPART> exit
(From yocto-docs rev: 1cc65ddf1a074f61fe5a63d222f3079b7fcb4c1e)
Signed-off-by: Marco Cavallini <m.cavallini@koansoftware.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Quoting Alexander Kanavin [1]:
> 1. BB_HASHSERVE and BB_SIGNATURE_HANDLER do not set up or start a
> server, they set up the hash equivalence client built into bitbake.
>
> 2. The above client configuration (used by poky) also starts a private
> server that is specific to a particular build directory. So hash equiv
> information would not be shared between multiple build directories,
> and this will cause sstate mismatches (as reported in the bug), if
> sstate is shared.
This setup does not shed light on the potential of the hash equivalence
feature. So for now, remove this basic setup, and later rework the
concepts (or create a new) document that explains how to set up a hash
equivalence server shared between builds.
[1]: https://lore.kernel.org/r/CANNYZj_kvLsZG3sgH+nPu9B=pqWBU785w0SGHGdQqB4UW-DtmA@mail.gmail.com
Suggested-by: Alexander Kanavin <alex.kanavin@gmail.com>
(From yocto-docs rev: 231fc9e710ab34db60263f8ae01d4f5970579203)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Remove the shared PERSISTENT_DIR mention introduced by 3954eda78f22
("dev-manual/start.rst: mention that PERSISTENT_DIR should be shared
too"), as it should _not_ be shared.
Instead recommend setting up a hash equivalence server.
(From yocto-docs rev: f9f1c87424d307d2df60024bc448bd6778605cf8)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
PERSISTENT_DIR should _not_ be shared, I got that wrong in my previous
commit 741aa29898dc ("ref-manual/structure.rst: update with info on
PERSISTENT_DIR"). Remove these mentions.
(From yocto-docs rev: 4c7fc7a6e9b0b957bcf0deb66adb0a6d9ebead00)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Replace the hardcoded /usr/bin by ${bindir}, as it should be.
Reported-by: Thomas Perrot <thomas.perrot@bootlin.com>
(From yocto-docs rev: 576677eae6960dbc2d2ececeba0fde5bba7bb69f)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The PERSISTENT_DIR directory can also be customized to be shared, so
mention it in the list of configuration variables in local.conf.
(From yocto-docs rev: f3aa0e8f0d15f036b65253c1e0036eb7e1e16088)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the "Development environment summary", we mention that the shared
state dir can be shared for developers, but PERSISTENT_DIR should be
shared as well, otherwise bugs described in [1] can happen.
[1]: https://bugzilla.yoctoproject.org/show_bug.cgi?id=15921
[YOCTO #15921]
(From yocto-docs rev: 3954eda78f22f205cbd31857f5b0992900fe7b02)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Since we mention that SSTATE_DIR can be shared for multiple builds, also
mention that PERSISTENT_DIR should be shared alongside SSTATE_DIR.
[YOCTO #15921]
(From yocto-docs rev: 741aa29898dc7f34ebd423ff7565334b2c89e18c)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The autobuilder also uses a shared Hash Equivalence server, so mention
it here too.
(From yocto-docs rev: a96640f98c91f147e05cf132efab114b1e7dc8eb)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the light of the recent LLVM addition, and other such heavier
recipes, increase the minimum RAM requirement from 8Gb to 32Gb.
(From yocto-docs rev: 3055affc8a37a40d03206140e47caf3d1437ec35)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
For host resource limiting variables, make a reference to the new
"Limiting the Host Resources Usage" document.
(From yocto-docs rev: 161a8549441e8c38791ab7f63001b2a15a39d2f2)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add a "Limiting the Host Resources Usage" document to share the
different techniques that can be used to limit the host resources usage.
We do have a document to document how to speed up a build, so this
document comes right after.
[YOCTO #15111]
(From yocto-docs rev: 584b8b30cd884ff6c62efcff9e9b566476a84589)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
While search queries already handled words with hyphens correctly, they
did not do so for words with dots.
To fix this, we
- enhance the word tokenizer to treat both dots ('.') and hyphens ('-')
as valid characters within words.
(For robustness, explicitly exclude dots/hyphens at the start or end
of a word from indexing.)
- adjust query processing to avoid splitting on dots in search input
This allows search queries to correctly match terms such as
'local.conf', 'site.conf', and similar ones now.
Fixes: [YOCTO #14534]
(From yocto-docs rev: 80084a4cabdf7f61c7e93eda8ddbd5bc7d54e041)
Signed-off-by: Enrico Jörns <ejo@pengutronix.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Replace 'git branch -al' with 'git branch -a' to correctly show both
local and remote branches. The '-l' option is unnecessary and may cause
confusion.
(From yocto-docs rev: 46aa3bb398c50af0f29acd2c1a05ee232d0de5b9)
Signed-off-by: Bo Sun <bo@mboxify.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Update the meta-intel BSP layer reference to point to README.md
instead of README, reflecting the actual file name in the repository.
(From yocto-docs rev: 32eb132ad69a0722e0075404f809bfe9df06adee)
Signed-off-by: Bo Sun <bo@mboxify.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add documentation for the new recipe-naming recipe QA test.
(From yocto-docs rev: 8f9ad9681c18412e9eedc014e686b1b72e458687)
Signed-off-by: Ross Burton <ross.burton@arm.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Update the short list of recipe files showing examples of proper
naming, and replace obsolete "irssi" example with example using "_git"
as a version.
(From yocto-docs rev: 95691fa4e7d30ee27cb1280df20751bf449538a4)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Shorten a small number of cumbersome recipe names by replacing them
with :oe_git: markup to link to their repositories.
(From yocto-docs rev: bdcc97d4d605c3de9682b9cb055c253547397f13)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
PowerPC (32-bit) remains relevant for our use cases, and we aim to
maintain support as long as it is feasible with reasonable effort.
For transparency, our primary focus is on maintaining
core-image-minimal. Support for more complex images may be limited
unless additional contributors join, as ongoing testing and maintenance
of these images may not be feasible otherwise.
(From yocto-docs rev: 63f0053f0f0201529bfad3e3f1b0211ac40ad1c2)
Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Current markup generates italic, not monospaced.
(From yocto-docs rev: 859ba2ea1014c351a43a59c481c4498d79f30139)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Correct two occurrences that imply source is always fetched as
tarballs.
(From yocto-docs rev: 57490852e6446672fd2cd0f3ee0befd9714c909f)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add a snippet from the wireless-regdb recipe to demonstrate a simple
example of a bin_package recipe.
(From yocto-docs rev: cbe3e272965cb706a73de36af01e1e0c65ea4efa)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Tweak the formatting of the bullet point title so that it renders both
the term and the bolding properly.
(From yocto-docs rev: 68068c5ab4f4c46c57bc055bd663f8e66096dd20)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The qualifier "By contrast" is more appropriate here, since that
phrase is used to introduce a point that is strikingly different from
what was just discussed, that being the substantial systemd.
(From yocto-docs rev: 3e73c7985dceb865e648f86ccd82aa0e7fc6668e)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Much of the reproduced bitbake.conf has nothing to do with showing how
the ${PN}-staticdev is defined, so delete most of it.
(From yocto-docs rev: e235ae40db8f4e7088b2e99e678cdf31b5e216c8)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Nothing major, just copy-and-paste from master branch to replace aging
code examples, and a little grammmar cleanup.
(From yocto-docs rev: 74057a1ffd682754e81f5f7fbde9f233e14a0d00)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- drop reference to "opkg", just refer in general to packagers
- correct what "QEMU" stands for (missing space)
- correct version conditional
- add a couple extra steps to typical workflow
- drop implication that one can modify local poky checkout
(From yocto-docs rev: 4fea81e42c41fc42548dd9e2b42f836daba5ac6b)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(From yocto-docs rev: 3728eea352f8b326ff411aa0f20bfd433ccc7cfa)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(From yocto-docs rev: 4e06c7f08a36c54a7f14760e609058468fab112f)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
It is not necessary to set both; just setting S to UNPACKDIR is enough.
This has already been done across oe-core master, and correct advice
should be given for those who need to adjust recipes during migration.
(From yocto-docs rev: e69144a2420cf412ff62a394583acc3f82413c69)
Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This wasn't specific, and is obsolete: UNPACKDIR should not be
set by recipes at all, except in very special circumstances
(e.g. gcc/clang unpacking into work-shared).
(From yocto-docs rev: a880d94d70c7ed1da8e40a02dae43ff1699941a6)
Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
On the ML was pointed about no specific information about
ptest-runner/ptests so improve docs around.
https://lists.yoctoproject.org/g/yocto-patches/message/1622
[YOCTO #15832]
(From yocto-docs rev: 0d1fd79019883f366d796b58a01679297d7a5508)
Signed-off-by: Anibal Limon <anibal@limonsoftware.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
