Using a reference to "do_package_write_deb", the first entry
in the list.
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 237cebcfa6215d75bbe28df677f18ebf7e1bb4f6)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- Create a new entry in the glossary
- Add implementation details
- Replace the mention of "init ramdisk" by "initramfs¨
whenever possible
- Remove obsolete and duplicate information
- Fix spacing issues in the Sphinx code
(From yocto-docs rev: 952c7e6dee49532705b2c162f4728e635c38df3f)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This now includes a description about how to create a template
with the newly added tooling, and drops the description
of .templateconf as a way to point to a custom template
(which is not correct: .templateconf is used only to point to a default
template in poky or core when TEMPLATECONF is not specified).
(From yocto-docs rev: d8e43d4ff4d6a0a4557d5dcedf11c1e45a223e72)
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>
This is really not needed as the sub-commands are described in
greater detail just below, and is prone to become outdated.
(From yocto-docs rev: 70735edb17c3c855a77318d3ae44d24d8aa8eb75)
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>
Using SRC_URI:append without recipe, machine or architecture specific
limitations makes the :append'ed text more difficult to override than if
the "+=" operator was used. This makes it hard for example to override
SRC_URI completely in a bbappend to update the full recipe to a newer
version. Thus common, reusable layers which users are meant to re-use
and customize should not use SRC_URI:append but SRC_URI += instead.
(From yocto-docs rev: 34533ac2ee5d85a41330dd865062dce1e46b83fc)
Signed-off-by: Mikko Rapeli <mikko.rapeli@linaro.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The templates have recently been moved by meta-yocto's commit [1].
Clean up some whitespace issues along the way.
[1] 29608bd03e1b ("meta-poky/conf: move default templates to conf/templates/default/")
(From yocto-docs rev: 661c554224dd79e79afd22b84608e248d3336aac)
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>
For correct rendering of the note
(From yocto-docs rev: cc765028a7cd3dda6942450b3d59d283bf73a8f7)
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>
Screenshot from executing an NPM package built by npm.bbclass
(From yocto-docs rev: 57acf2f65e5e5798f369a24c4a0cc9b5cdb8e1db)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
From running the instructions using Poky master
In particular, update command output and the contents
of generated files.
The "cute-files" example application can now directly be run,
without having to run it through "node".
(From yocto-docs rev: a100fb1e25e3f2e144d771d31e952deae2fe3302)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fix some hyphens being improperly used as em dashes.
See https://www.grammarly.com/blog/hyphens-and-dashes/
Using em dashes may also allow Sphinx to hyphenate
and break lines in the best way.
Note that the first character after an em dash not
supposed to be capitalized, unless a specific
rule applies, typically when what follows is a proper noun.
Fix a few misuses of parentheses in following text.
(From yocto-docs rev: 5918f019f63f6e820b1168f4cc001faa1d1cdc6f)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
As enforced by meta/classes/sanity.bbclass:
- at least GNU make 4.0
- at least GNU tar 7.5 (instead of 5.0)
(From yocto-docs rev: 6480aa0f8338ef192c666b9445bc0baff47d9248)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fix a wrong reference no longer tolerated by Sphinx 5.0.1
(missing "bitbake:" prefix)
Add missing double quotes in a reference to a chapter title
(From yocto-docs rev: 9a797dedf6708da3e7ce789c5c8735e5d891cde4)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Multiconfigs now work from layers. Update the documentation to match this change.
Also fix a incorrect reference to different distros working within the same TMPDIR,
that is incorrect.
[YOCTO #13566]
(From yocto-docs rev: cb35f75bfc98c9098f9af64b9dd040b25779da36)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add it to the variable index
Misc improvements to the documentation for this variable
(From yocto-docs rev: fb460a7c7aba1ad5754806f9cfad9ef591420317)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Better for EPUB output in particular
- Make some diagrams wider when necessary
- Remove ":align: center" when we have ":width: 100%"
- Update the standards.md files to mention this
(From yocto-docs rev: 848ba7bd8984cc3f4bf6b818259865011cde0476)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- Using "BitBake" instead of "Bitbake" or "bitbake", aligning with the
title of the "BitBake User Manual".
- Using "OpenEmbedded" instead of "Openembedded"
- Using "Python" instead of "python"
(From yocto-docs rev: 0b893e2a15aefedd7100445fc9d7eeed07b6afc6)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
[Yocto #13722]
The Yocto bug reports a few improvements in the gdbserver configuration
which makes the configuration of gdb easier for novice users.
(From yocto-docs rev: 48c96378fd5edd587025f3ca138bc5114e927f2f)
Signed-off-by: Sundeep KOKKONDA <sundeep.kokkonda@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
We don't publish tarballs using this version any more, it has been
removed everywhere. Remove the obsolete references in the docs,
adapting references accordingly. The tarballs now are just created
with their sha256 checksum which we don't want or need to reference
in the docs.
(From yocto-docs rev: c7a0ac88b01c48f3d9209536542bf43ae7a7937f)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
journald is not a syslog provider, so using journald exclusively amounts
to just preventing a syslog provider from being specified on a system
where journald is active.
Various spots where this has popped up:
* https://stackoverflow.com/q/48746397
* https://lists.yoctoproject.org/g/yocto/topic/82883035#53548
(From yocto-docs rev: aba38d5dc2db708ed6e8fc6dca4d869fe7fe855c)
Signed-off-by: Nicholas Sielicki <nicholas.sielicki@legrand.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changes identified by OE core's
scripts/contrib/convert-variable-renames.py script
Original variable names are kept in old migration notes,
but references to the new ones are provided.
(From yocto-docs rev: 1a35380ca80509fee036018a2bbb22ba9b44d47a)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Branch information is now mandatory for git:// and gitsm:// URIs
(From yocto-docs rev: b862655d812e358dd15b06c0548a276a90666423)
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>
Using DiskPart for the systems which lack optimize-vhd
(From yocto-docs rev: c692b77065e6bd8eda789a88fa8fae1351a7274d)
Signed-off-by: Tony McDowell <svet.am@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixing documentation and updating examples containing "prelink"
in their output.
(From yocto-docs rev: 8927b8fff55fac1bd1fefcff2d16141dbd1ebc51)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This is similar to the recent change in meta to only use SPDX license
identifiers in the recipes.
(From yocto-docs rev: 147ce973d08f0bfb59b7b87fec8c8cc997d57112)
Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.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>
Since commit 98b3ed1b2e "meta/scripts: Handle bitbake variable
renaming", the new name of the variable is BB_BASEHASH_IGNORE_VARS
so let's update it so that Sphinx can resolve the Bitbake reference.
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: a6c6283e9cc30ca580f1719d8e22fca5f79c1e50)
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>
dev-manual/common-tasks.rst: Add section to create an initramfs
image from a separate multiconfig.
ref-manual/variables.rst: Add new variable definitions for
INITRAMFS_DEPLOY_DIR_IMAGE and INITRAMFS_MULTICONFIG
(From yocto-docs rev: 7853ab3df82c27ba309879a66a084b2e597dc1e5)
Signed-off-by: Alejandro Enedino Hernandez Samaniego <alhe@linux.microsoft.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Since f748564653 ("kernel: provide virtual/kernel for all kernels"),
all recipes which inherit kernel.bbclass provide "virtual/kernel",
independent of the value of `KERNEL_PACKAGE_NAME`.
(From yocto-docs rev: da69e75c7f84f51c8fa95e9217e11b4b36af52d6)
Signed-off-by: Christian Eggers <ceggers@arri.de>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- Simplify references to class sections, by replacing references such as
:ref:`image.bbclass <ref-classes-image>`
by
:ref:`ref-classes-image`
That's equivalent, because the class sections always called <class>.bbclass
- Adding references to class sections, by replacing strings such as
``image.bbclass``
by
:ref:`ref-classes-image`
- Simplifying a few class section links
(From yocto-docs rev: 29d66aaa898390c19f121baf0f4fdcc178e4cd80)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This explains how to deal with versioned and unversioned
pre-built libraries from vendors.
Content and examples adapted from
https://wiki.yoctoproject.org/wiki/TipsAndTricks/Packaging_Prebuilt_Libraries,
originally written by Henry Bruce in 2016.
(From yocto-docs rev: 5e46cad9e4b4ab03e33f4d5aea34e56f6b15fe27)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Now defunct
(From yocto-docs rev: 52f7aedda58becb081eeca4a1bc02068f72d7c4a)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
direction -> directory
(From yocto-docs rev: 441151bfdeda6eccf46a7829d1a3181e83d441a8)
Signed-off-by: Robert Joslyn <robert.joslyn@redrectangle.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
While nightly builds are still run, they only produce
test files and reports. They are no longer a solution
to use the latest code.
(From yocto-docs rev: ace9f81ade851bb1b0d98a050007fffbc62b938d)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Almost everyone understands "rootfs", but "root filesystem"
is real English.
(From yocto-docs rev: 3d610f15e5b6be3435e9e81e4498a676671e5b39)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Three's been some feedback saying that people actually missed that
paragraph and thought creating the layer by hand was the only way to do
it instead of leveraging bitbake-layers create-layer tool.
Let's try to make it a bit more obvious one does not need to create the
layer by hand by putting the paragraph into a note.
(From yocto-docs rev: 2b171d267ae37d467f8437c4739f32e5253049b3)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Except the name of variables which can't be changed only in the
documentation for obvious reasons and workflow or developement
explanations around the use of the "master" branch which cannot be
replaced with "development" branch instead, most of the non-inclusive
words that appear in https://inclusivenaming.org/word-lists/tier-1/
should have been replaced in this patch.
(From yocto-docs rev: 2755f35060084f7af356091de9dc144f85530fe2)
Signed-off-by: Quentin Schulz <foss+yocto@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This makes the manuals easier to use.
Note the care to keep the paths visible, so that people
reading a printed version still know where to find the files.
(From yocto-docs rev: 501917f65530f14ea686b69d6e96407c3f970a28)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This addresses [YOCTO #14531] after the "devpyshell" task was renamed
to "pydevshell" in OE core.
(From yocto-docs rev: 1056320e90545c8dff0fc71a5fde752295d4d6e4)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Modern Debian based distros (such as Ubuntu) now
use "apt" instead of "apt-get"
Also make sure "apt" is invoked with root privileges (mandatory)
(From yocto-docs rev: 380ef2474f3ecc2bce83f11cd838d054bef56d22)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This fixes font inconsistencies, mixing a ``text`` string
with another string with the regular font, where the whole string
makes more sense with a single font.
The result is also much simpler and will make future
searches easier.
(From yocto-docs rev: e6d1c166a97a1b6bb42ca49dfcbd3d39f8eadc16)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Ensure users are aware that usage of INITRAMFS_IMAGE_BUNDLE is only
appropriate for use with GPLv2 compatible software.
(From yocto-docs rev: 1859654663ebb3b051fb6c4da4dc76f0dd46c47c)
Signed-off-by: Daniel Wagenknecht <dwagenknecht@emlix.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Output order from "wic list images" is in different order, and was
missing a couple entries.
(From yocto-docs rev: 7df7356b8a306d7e77f0aab1f443fd1306c25620)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Tweak the bblayers.conf example to encourage the reader to appreciate
that any new layers should not share space with the official Poky
checkout.
(From yocto-docs rev: 46931f8497c3c4b874613acbe7c9612944174559)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This deletes the history sections in each sub-manual,
which didn't add any value, given that they didn't list
the changes from one Yocto Project version to the next.
(From yocto-docs rev: 29ce5b89c438079793cc6457401b6a9275db877a)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Use the xserver-xf86-config_%.bbappend from meta-raspberrypi to provide
an example of having a bbappend file add files to an existing recipe.
(From yocto-docs rev: f510e748ff3bcbea6e34a7f225e05628303fdd12)
Signed-off-by: Tom Rini <trini@konsulko.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Since there are actually four listed requirements, just drop the
number to avoid future issues.
(From yocto-docs rev: 612015dc227600d23956402eab7f324e0c8fd42a)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Some minor grammatical and structure tweaks.
(From yocto-docs rev: 505f9b21898475746d401c8ab79b95f3dc4d02e7)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Just a collection of:
- grammar tweaks
- space fixes
- font changes
(From yocto-docs rev: c49984f89cd2295c54f01730649aaca83eaf515e)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Without this, readers could think that "devpyshell" is a script,
at least until they read the remainder of the section.
(From yocto-docs rev: fe1e3323a633acf51d64cfb6c4bdd2ecd324a79e)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the example in section 3.9, the call to d.getVar() needs to have
the additional argument of "False" so that the output is not expanded.
(From yocto-docs rev: ae364e76a322278e7fe37aeecaa5e854d0a0efee)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Tested-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Specifically, the actual recipe now has LICENSE=MIT.
(From yocto-docs rev: 9f64931308f73607c40ed1eb8cf915666b6ff90a)
Signed-off-by: Ross Burton <ross.burton@arm.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
To prepare to add another example bbappend, rename the current "Using
.bbappend Files in Your Layer" section to "Appending Other Layers Metadata
With Your Layer". Name the current example as "Overlaying a File Using
Your Layer".
(From yocto-docs rev: 62d7b5721b2fbcf1e22fc4e7bbac51d52260730e)
Signed-off-by: Tom Rini <trini@konsulko.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Try and make it clearer what the final result of this bbappend example
is.
(From yocto-docs rev: c6d0b030fe495a9eb81ad542ad56479f7e7e18e2)
Signed-off-by: Tom Rini <trini@konsulko.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There are many more instances of "filename" or "filenames" than
of "file name" or "file names".
The winner takes it all!
(From yocto-docs rev: 13ef92bc301166c2e21d2603b2501749248dbe91)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated with openembedded-core/scripts/contrib/convert-overrides.py
(From yocto-docs rev: 105c4af0f2d78f27639f4f4d8ee4be65fcbfda52)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This adds details about the actual implementation
of vulnerability checks, about how to fix or ignore
vulnerabilities in recipes, and documents the
CVE_CHECK_PN_WHITELIST and CVE_CHECK_WHITELIST variables.
(From yocto-docs rev: 55886d211218b3a604c2f8a29c854685ebf284dd)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This starts to document vulnerability management
and the use of the CVE_PRODUCT variable
(From yocto-docs rev: 2b9199fe490cb3ec126bffc6518646194a94ace4)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The standard :term:`VARIABLE` will refer to the
description of the variable in the YP variable index. If it
doesn't exist, it will refer to the description of the variable
in the BitBake manual.
(From yocto-docs rev: 34cb466caf872f9284eb81f6a5f31ad606214dee)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Replacing ":ref:`section name<bitbake:bitbake-user-manual/bitbake-user-manual-<section>:section name>`"
by ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-<section>:section name`"
when the reference description is the same as the section name.
In this case, that's unnecessary to repeat the section name in the description part.
(From yocto-docs rev: 6a1a590f9ef77dc8842ea5945661135992eb94e1)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The file 'meta/classes/core-image.bbclass' seems have nothing about
the 'IMAGE_FEATURES' variable, using 'meta/classes/image.bbclass' instead.
(From yocto-docs rev: b0eb9ef09c73db97e3f289565d0ce17d9aa7e8cd)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Mingrui Ren <jiladahe1997@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
A few occurences appeared between the time the original patch was sent
and it was applied, this fixes it.
Also, the original patch didn't take into account lowercase terms, this
is now fixed, see module_autoload for example.
Finally, as is often the case with regexp, there was a typo in it that
didn't make it match as much as it should have.
The script that is used to do the replacement of ``FOO`` by :term:`FOO`
is the following Python code:
import re
from pathlib import Path
from runpy import run_module
import contextlib
import io
import sys
re_term = re.compile(r'variables.html#term-([a-zA-Z_0-9]*)')
terms = []
new_terms = set()
with contextlib.redirect_stdout(io.StringIO()) as f:
run_module('sphinx.ext.intersphinx', run_name='__main__')
objects = f.getvalue()
match = re_term.search(objects)
while match:
if match.group(1):
terms.append(match.group(1))
match = re_term.search(objects, match.end())
for rst in Path('.').rglob('*.rst'):
with open(rst, 'r') as f:
content = "".join(f.readlines())
for term in terms:
content = re.sub(r'``({})``(?!.*\s+[~=-]{{{:d},}})'.format(term, len(term)), r':term:`\1`', content)
with open(rst, 'w') as f:
f.write(content)
This script takes one argument as input: an objects.inv. Bitbake's can
be gotten from https://docs.yoctoproject.org/bitbake/objects.inv. The
objetcs.inv from the current git repo can be gotten from
documentation/_build/html/objetcs.inv after running `make html`.
Note that this excludes from replacement terms that appear in section
titles as it requires refs to be changed too. This can be automated too
if need be but right now it looks a bit confusing to have an anchor link
(for sections) also have a term/reference link in it. I am not sure this
is desired today.
This is the result of two runs of the aforementioned script, once with
Bitbake objects.inv and once with this repo's.
Fixes: ba49d9babfcb "docs: replace ``FOO`` by :term:`FOO` where possible"
(From yocto-docs rev: 1e1b0c4dd241b6657035172b1f7b5f341afa8b25)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The image-mklibs bbclass was removed from OE-Core with
commit 908df863b419d1cad7317153101fc827e7e3a354 and
corresponding changes to local.conf.sample were made
in meta-yocto with c8c8f284eb2abe7e1352850a885454487cc01986.
Remove all references to image-mklibs from the documentation
as it is no longer supported.
(From yocto-docs rev: f45b378eb2cb08c173620cffb17cbcc8b402da0d)
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
If a variable has a glossary entry and some rST files write about those
variables, it's better to point to the glossary entry instead of just
highlighting it by surrounding it with two tick quotes.
This was automated by the following python script:
"""
import re
from pathlib import Path
with open('objects.inv.txt', 'r') as f:
objects = f.readlines()
with open('bitbake-objects.inv.txt', 'r') as f:
objects = objects + f.readlines()
re_term = re.compile(r'variables.html#term-([A-Z_0-9]*)')
terms = []
for obj in objects:
match = re_term.search(obj)
if match and match.group(1):
terms.append(match.group(1))
for rst in Path('.').rglob('*.rst'):
with open(rst, 'r') as f:
content = "".joing(f.readlines())
for term in terms:
content = re.sub(r'``({})``(?!.*\s*[~-]+)'.format(term), r':term:`\1`', content)
with open(rst, 'w') as f:
f.write(content)
"""
(From yocto-docs rev: ba49d9babfcb84bc5c26a68c8c3880a1d9c236d3)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Update Docker installation URL on various plaforms, replacing
some URLs by the ones they now redirect to, renaming "Docker CE"
to "Docker Desktop" on Mac and Windows, and to "Docker Engine"
on GNU/Linux.
Stop mentioning "Docker Toolbox" which is now deprecated and
replaced by "Docker Desktop" on Mac and Windows.
(From yocto-docs rev: 8eb249aed50b7b5b2078648c9efd9c79262ae57f)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
