To complement what I am adding to the BitBake reference manual, add a
section in the 4.2 migration guide, a reference in the structure section
of the reference manual (where we talk about meta/lib) and adjust the
release notes item to be a little more concise.
(From yocto-docs rev: 0903e82a9da263c6d64aead03407eb377eb5bbfe)
Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
New in 4.2 (pointer to BitBake manual, changes sent separately for
that).
(From yocto-docs rev: a2112eb3f1084040ad48e392075297b4630b93e1)
Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This technique is no longer used (nor necessary), let's just remove it
to avoid any confusion.
(From yocto-docs rev: 8f50d0bf22fea8064c112f52df06dbd6a85a7a83)
Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
IMAGE_MACHINE_SUFFIX is a new variable in 4.2, and there were some
associated changes to how IMAGE_NAME, IMAGE_LINK_NAME,
INITRAMFS_IMAGE_NAME and KERNEL_ARTIFACT_NAME are set by default. As a
result, instead of repeating how KERNEL_ARTIFACT_NAME is set by default,
let's just direct people to the entry for that variable so we only have
to update one place.
At the same time I noticed INITRAMFS_IMAGE_NAME was not documented at
all, so add that in.
(From yocto-docs rev: d53bf2878a268fb71785c73053e3657436f3f5ba)
Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- Fix the location of the target for supported distributions
- Improve the name of this target
(From yocto-docs rev: 40f0cf9302b9f0ce01a1270977644b1b2fdfc650)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- Remove note to section not carrying information about
special hosts tools for oe-selftest
- Add links to mentioned repositories
CC: Ross Burton <ross.burton@arm.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Measured by generating a "core-image-sato" image for a "qemux86-64"
machine from an Ubuntu 22.04 VM with 4 cores.
Less memory was not enough and caused Out of Memory failures.
(From yocto-docs rev: a05f87929eed43cef673a8c2581899a8c9ccf462)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Tests made on Poky master on March 16, 2023.
Add a "Free Disk Space" section to the "System Requirements" document.
(From yocto-docs rev: 285ba689ce3ab7b7fdb4bb0d0284e2a52ad62c7f)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- Replace by a reference to the description which was
moved to the BitBake manual.
- Also drop the reference to the Yocto Project Development Tasks Manual
which doesn't add extra information on this variable.
(From yocto-docs rev: 87cdda981fa6a3d05c559fb00e214214956346dc)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- This allows to continue sharing the updated Ubuntu/Debian requirements
with the brief-yoctoprojectqs/index.rst without indentation mismatches
(caused by using the same macro in two different contexts: in direct
text and in a bullet list).
- Update poky.yaml.in to adapt the number of spaces at the beginning
of lines.
- brief-yoctoprojectqs/index.rst: fix bad number of spaces
before quote block.
(From yocto-docs rev: 38a3228f8981674bc75de135246c4f9eff7b43a1)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- Update system requirements after making tests on basic Docker
containers of:
- Ubuntu 22.04
- Fedora 37
- OpenSuse Leap 15.4
- AlmaLinux 9
- Including the need to have the en_US.UTF-8 locale on the system.
- Rename the CENTOS8_HOST_PACKAGES_ESSENTIAL macro to ALMALINUX_HOST_PACKAGES_ESSENTIAL
As for the other distros, stop refering to a specific version of AlmaLinux. We mention
the supported versions in the system-requirements.rst file anyway.
- Remove the unused CENTOS7_HOST_PACKAGES_ESSENTIAL macro
(From yocto-docs rev: f8b8680ff1f54b02572f240966169b9e129b05b1)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Randy MacLeod <randy.macleod@windriver.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- Replacing
:ref:`bitbake:bitbake-user-manual/...`
by :ref:`bitbake-user-manual/...`
Adding "bitbake:" as a prefix is not necessary
as there is no naming conflict between the YP
and the BitBake manuals (all documents are in
"bitbake-user-manual/")
- Explaining the rules in the README file
- When necessary, fixing line length in the modified paragraphs.
(From yocto-docs rev: d80b31705450cfb98d217ea44ba2edace2d64095)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- Add COMMERCIAL_[AUDIO|VIDEO]_PLUGINS variables to the
variable index.
- Clarify that these plugins are still open-source
- Improve line width
(From yocto-docs rev: 8b161faad6b698b33165f02e1f5e78a693c7817b)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Since release 4.1, the variable DEV_PKG_DEPENDENCY sets RRECOMMENDS instead
of RDEPENDS for the -dev package on the main package, this change fixes the
documentation to match the actual state
Reviewed-by: Yoann CONGAL <yoann.congal@smile.fr>
(From yocto-docs rev: 0e0790e7bcf4ee2d31301b4351528eb124a1fe98)
Signed-off-by: Fawzi KHABER <fawzi.khaber@smile.fr>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Replace the invalid feature name with correct one which helps to avoid
following bitbake error
ERROR: Nothing PROVIDES 'core-image-minimal'
core-image-minimal was skipped: 'empty-root-passwd' in IMAGE_FEATURES (added via EXTRA_IMAGE_FEATURES) is not a valid image feature.
(From yocto-docs rev: 1c7086a3eda6539f09cae8917ccace93b14f8e9c)
Signed-off-by: Niko Mauno <niko.mauno@vaisala.com>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
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>
Although in the example case of a "raspberrypi2" the variable KMACHINE has the
same value as MACHINE, only the latter is an allowed override. So do not set the
reader on the wrong track.
Suggested-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
(From yocto-docs rev: 565ebcfe3ed68a9ea036f11cddafb36023f72099)
Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Additionally use more common syntax to indicate that an actual machine name is
supposed to be filled in for a concrete use case as has been suggested by Peter
Kjellerstedt (and particularly no KMACHINE). Furthermore add missing quotes in
the reference manual.
Suggested-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
(From yocto-docs rev: b66c035970f860b65cf712285f2d5a023620e6c3)
Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- Fix broken link to a .bb file
- Clarify the explanations
(From yocto-docs rev: 937ef39cb4d04da388b1945d741820089daa2780)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These :yocto_docs: references were making external references
to another section of the manual, using the https://docs.yoctoproject.org
website. It's actually better to use internal references (:doc: for an
entire document, and :ref: for a specific section, as they will cause
an error in Sphinx if one day they are no longer valid.
(From yocto-docs rev: 0beff9dea986a2ea4b496180b29a99490416eeeb)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
OE-Core rev f1257d61b76d027d4ece734439993b6bf4e48907 introduced support
for using lzo as compression algorithm for fitImage contained kernel
images.
This patch adds the corresponding documentation to FIT_KERNEL_COMP_ALG
and FIT_KERNEL_COMP_ALG_EXTENSION.
(From yocto-docs rev: aba0ab326ea72ff10492e73b452b51d1beaa50d6)
Signed-off-by: Richard Leitner <dev@g0hl1n.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
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>
On the side, also simplify a reference to the section describing them.
(From yocto-docs rev: 0c13a7f9ccee4ddc9c6034d03f47625a09598cec)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- Remove the redundant FAQ entry about this topic,
already covered in a specific section of the Development Tasks manual
- Document the TOOLCHAIN_LOCATION variable
- Expand both the Development Tasks manual and
the TCMODE variable description using details from the FAQ entry.
- Mention the "meta-arm-toolchain" layer too.
(From yocto-docs rev: 53faa54a8e6311b4d3d41d96cb1a497d0f6502fb)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Simplify formating for better looking output.
For example, mosts paragraphs had only ther ":" character in boldface.
(From yocto-docs rev: 833ea5d06dd46e79b2d02752f2c41a4c3a54a2f9)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixing double colons appearing alone on a line, while
they could be put at the end of the previous line.
Sometimes placing a note after the quoted text
to avoid such a situation. It's more natural too
not to have a note between the introduction text
and the quoted section.
(From yocto-docs rev: fb054622f5119444eb947fe580253f37e0d872c6)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
