summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
* conf.py: rename :cve: role to :cve_nist:Antonin Godard2024-11-1130-466/+466
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Newer versions of Sphinx already define a :cve: role that points to cve.org, instead of the role we defined in conf.py that points to nvd.nist.gov. Rename our role to :cve_nist: to avoid warnings (treated as errors). This is also backwards compatible, meaning we can build the doc with an older Sphinx if needed. The file were automatically replaced with following command: find . -name '*.rst' -exec sed -i 's/:cve:/:cve_nist:/g' {} \+ Cherry pick: * Changes on following files removed from cherry pick (not part of kirkstone): documentation/migration-guides/release-notes-4.1.1.rst documentation/migration-guides/release-notes-4.1.2.rst documentation/migration-guides/release-notes-4.1.3.rst documentation/migration-guides/release-notes-4.1.4.rst documentation/migration-guides/release-notes-4.1.rst documentation/migration-guides/release-notes-4.2.1.rst documentation/migration-guides/release-notes-4.2.2.rst documentation/migration-guides/release-notes-4.2.3.rst documentation/migration-guides/release-notes-4.2.4.rst documentation/migration-guides/release-notes-4.2.rst documentation/migration-guides/release-notes-4.3.1.rst documentation/migration-guides/release-notes-4.3.2.rst documentation/migration-guides/release-notes-4.3.3.rst documentation/migration-guides/release-notes-4.3.4.rst documentation/migration-guides/release-notes-4.3.rst documentation/migration-guides/release-notes-5.0.2.rst documentation/migration-guides/release-notes-5.0.3.rst documentation/migration-guides/release-notes-5.0.rst documentation/migration-guides/release-notes-5.1.rst * Fix minor conflicts in following files: documentation/migration-guides/release-notes-3.4.2.rst: missing :term: before CVE_PRODUCT documentation/migration-guides/release-notes-4.0.2.rst: missing :term: before PACKAGECONFIG documentation/migration-guides/release-notes-4.0.7.rst: missing cve 2022-32912 on webkitgtk Suggested-By: Quentin Schulz <quentin.schulz@cherry.de> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: f432e78fef82c5e5bfdfff08bb18757dc3479465) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 15fa3b7e85dde50d7236c1738ad607531cc654b8) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: devtool-reference: document missing commandsAntonin Godard2024-11-111-1/+31
| | | | | | | | | | | | | | | Give a brief description for important commands that made it into devtool or that were missing from this quick reference document. Cherry pick: Remove devtool ide-sdk from commit, this command was not backported to kirkstone. (From yocto-docs rev: 8a5111c406be9c4bf1cc78a34dd2174a227ca79c) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 6238adae1b072c9e09c558038d397dfac6ec109f) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* release-notes-4.0,brief-yoctoprojectqs: update BB_HASHSERVE_UPSTREAM for new ↵Steve Sakoman2024-11-062-2/+2
| | | | | | | | | | | | infrastructure Public hashserver is now at hashserv.yoctoproject.org:8686 (From yocto-docs rev: fe98cb44fd52e2e455255be33aacf60f12dd5bad) Signed-off-by: Steve Sakoman <steve@sakoman.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: devtool-reference: refresh example outputsAntonin Godard2024-11-061-11/+7
| | | | | | | | | | | | Previous outputs were missing some commands and options, some others were obsolete. (From yocto-docs rev: e3245843543361f8eeda0fcc583fb3f7a36eaeb5) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 1c83037707b4c981a70c968ba04ded502f9bffbf) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: release-process: add a reference to the doc's releaseAntonin Godard2024-11-061-0/+2
| | | | | | | | | | | | | | When reading the stable releases section, we want to know for which release the documentation was built. Use &DISTRO_NAME; to refer to the current release. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 0f21321d8b30478ed07f0387f4b88cd0a5c03fd1) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 05ee6844d710beb844bbdac892888879847f6d22) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: release-process: update releases.svg with month after "Current"Antonin Godard2024-11-061-9/+9
| | | | | | | | | | | | | | | | This way we put a timestamp on the image, so that someone looking at the image on an old release tarball has a representation of the release "as of <date>". Here set "Oct. 24" as it was the last time the file was updated. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 108b53abd96fa7fd82107de07a46ae77a6f9269f) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 7b62bbec900bc84a31e4686839e774ba7bd5ae9f) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* migration-guide: add release notes for 4.0.22Lee Chee Yang2024-11-022-0/+197
| | | | | | | | | | | (From yocto-docs rev: f08f4c664ffd49d23c7318d88604d1c940f0298a) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 9563855ccd92e21fb6f8320c96a3a83e115c947e) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: release-process: refresh the current LTS releasesAntonin Godard2024-11-021-6/+9
| | | | | | | | | | | | | | Mention that Scarthgap the latest LTS in a bullet list next to Kirkstone. Reword the parapraph a bit to make it clearer after this change. Reviewed-by: Michael Opdenacker <michael.opdenacker@rootcommit.com> (From yocto-docs rev: 23c4ca4fdfffb7793cf4ffaea365e042e1a25325) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit afeded9939777d88bf4cb9ebf7a61aadd476642d) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: release-process: update releases.svgAntonin Godard2024-11-021-561/+346
| | | | | | | | | | | | | * Add Walnascar release. * Remove dunfell, gatesgarth, hardknott, honister: these release are not supported anymore. Start from kirkstone, which is still supported. (From yocto-docs rev: 1955aa1052d16a05cc7d493d5e7c0fe113141812) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit aa9a580c8c57af4baa4fb24a43487fb7afc258e5) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* overview-manual: concepts: add details on package splittingAntonin Godard2024-11-021-5/+56
| | | | | | | | | | | | | | | | | | | | | | | | | | | The package splitting section of the overview manual currently lacks any explanation of how package splitting is implemented and redirects to the package class, which is not really understandable for newcomers to the project. This patch adds a short explanation of what is done: * How the PACKAGES variable is defined. * How the FILES variable is defined. * How the two work together. * How to add a custom package. This should give enough details to a new user on what package splitting achieves and how to add a custom package. Adresses [YOCTO #13225] Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: ef4150029d377ce1c35645971502ae56345915a6) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 143c3cacdec36c9d7ab81c89bbcc12c0c3936bd9) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: structure.rst: document missing tmp/ dirsAntonin Godard2024-10-241-2/+33
| | | | | | | | | | | | | | | | Document `hosttools/`, `pkgdata/` and add some more information on `work-shared/`. Adresses [YOCTO #14543]. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 259fce03ffab9fb588676c1e150d999d54cf6d85) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 372b5b4ca55819c294970b20aa8b8d8167144329) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: add missing OPKGBUILDCMD variableAntonin Godard2024-10-241-0/+7
| | | | | | | | | (From yocto-docs rev: 709d952ba834778015b3047f8bafca94b1c814f8) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit a6a2c8e48995200c9c3be7096f34d912427de145) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: add missing EXTERNAL_KERNEL_DEVICETREE variableAntonin Godard2024-10-241-0/+12
| | | | | | | | | | | | | This variable can be used to specify one or more compiled device tree or device tree overlays to use in addition to the one compiled by the kernel. (From yocto-docs rev: 708514ea676246ddf251ad47c95442e8ec5c0e1f) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 6566ffceab3780dc5ecbfe26f786ebe6ff17e693) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: add missing CVE_CHECK manifest variablesAntonin Godard2024-10-241-4/+11
| | | | | | | | | | | | Variables that can be used for toggling creation of manifest and specifying the path to the output in the deploy directory. (From yocto-docs rev: fb462c47bb15522cc02642fe51f39c8e15044957) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 14131a42a7ea8bbae2165c1b8dbcabd5f28b2b22) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: introduce CVE_CHECK_REPORT_PATCHED variableAleksandar Nikolic2024-10-241-0/+6
| | | | | | | | | | | (From yocto-docs rev: a7929332ade42e8511c2f47d200b3b01cb8a8987) Signed-off-by: Aleksandar Nikolic <an010@live.com> Reviewed-by: Michael Opdenacker <michael@opdenacker.org> Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com> (cherry picked from commit f585a68a8f35f31814e408dd973ea7345adbbacf) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* migration-guide: add release notes for 4.0.21Lee Chee Yang2024-10-102-0/+167
| | | | | | | | (From yocto-docs rev: 2169a52a24ebd1906039c42632bae6c4285a3aca) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* doc/features: remove duplicate word in distribution feature ext2Jörg Sommer2024-09-271-1/+1
| | | | | | | | (From yocto-docs rev: fa846606014a85154b63794a17ff1d9aacc1a7bc) Signed-off-by: Jörg Sommer <joerg.sommer@navimatix.de> Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* migration-guide: add release notes for 4.0.20Lee Chee Yang2024-08-232-0/+132
| | | | | | | | (From yocto-docs rev: 512025edd9b3b6b8d0938b35bb6188c9f3b7f17d) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: fix typo and move SYSROOT_DIRS exampleMatthias Pritschet2024-08-231-24/+24
| | | | | | | | | | | 1. Changed one letter (s/B/A), so the sentence is correct again. 2. Moved example from SYSROOT_DIRS_IGNORE into SYSROOT_DIRS section. (From yocto-docs rev: 9fcd6d6ef4a87f69b8a00907051c1ece41e75a82) Signed-off-by: Matthias Pritschet <matthias@pritschet.eu> Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* migration-guides: add release notes for 4.0.19Lee Chee Yang2024-06-242-0/+160
| | | | | | | | | | | add release notes for 4.0.19. (From yocto-docs rev: b15b1d369edf33cd91232fefa0278e7e89653a01) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Michael Opdenacker <michael@opdenacker.org> Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: update releases.svgMichael Opdenacker2024-05-151-38/+61
| | | | | | | | | | - Make Scarthgap a current release - Add Styhead (From yocto-docs rev: 78b8d5b18274a41ffec43ca4e136abc717585f6d) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* migration-notes: add release notes for 4.0.18Lee Chee Yang2024-05-152-0/+192
| | | | | | | | | | add release notes for 4.0.18 (rc1). (From yocto-docs rev: 59ef7dc0f3b6636fbc98c0d232fe8879efc325c6) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* documentation/poky.yaml.in: drop mesa/sdl from essential host packagesAlexander Kanavin2024-05-151-8/+8
| | | | | | | | | | | They used to be required for qemu graphics support, but neither is being for anything anymore. (From yocto-docs rev: 41db85d4d429f06548e14617e05d045958e8566d) Signed-off-by: Alexander Kanavin <alex@linutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* documentation: standards.md: align with master branchMichael Opdenacker2024-05-151-3/+94
| | | | | | | (From yocto-docs rev: ecc1731d6bd2f3bce40010bbfa3b608dcf25dd04) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* dev-manual: update custom distribution sectionPaul Eggleton2024-05-151-4/+30
| | | | | | | | | | | | | | In keeping with the addition of the motd message pointing out that the poky DISTRO is a reference distribution, adjust the opening of the Creating Your Own Distribution section to match. Additionally, add a section on the end pointing out what users need to consider if they just take a copy of the poky distribution and modify it. (From yocto-docs rev: 30bdf5a101466acdf63027bbdfb69ee18ed707ab) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: variables: Update default INHERIT_DISTRO valueGeoff Parker2024-05-151-1/+1
| | | | | | | | | | | Add remove-libtool to INHERIT_DISTRO defaults per meta/conf/distro/defaultsetup.conf (From yocto-docs rev: 94646665637d30d700e78598e0955815572c466c) Signed-off-by: Geoff Parker <geoffrey.parker@arthrex.com> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* manuals: remove tab charactersMichael Opdenacker2024-04-197-105/+105
| | | | | | | | | | | | | As reported by "make sphinx-lint" Tabs are even removed in Makefile examples, as Sphinx turns them to spaces anyway in the generated output. (From yocto-docs rev: fd1423141e7458ba557db465c171b0b4e9063987) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* kernel-dev: join mkdir commands with -pJörg Sommer2024-04-191-8/+2
| | | | | | | | | | | To make it more obvious which directories are needed, pass only these to *mkdir* and use the option `-p` to create the missing parents. (From yocto-docs rev: 4ddcedca4b09e2c051b33a40659ffce1db2984f5) Signed-off-by: Jörg Sommer <joerg.sommer@navimatix.de> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* manuals: fix incorrect double backticksMichael Opdenacker2024-04-191-1/+1
| | | | | | | | | As reported by "make sphinx-lint" (From yocto-docs rev: 18d86626406fe07d4f62ef0b9168c0220b3dd90a) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* manuals: fix trailing spacesMichael Opdenacker2024-04-1910-31/+34
| | | | | | | | | Fixing errors reported by "make sphinx-lint" (From yocto-docs rev: 45b04c281a567e06fd2904166bcc26603e73e684) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* manuals: add initial sphinx-lint supportMichael Opdenacker2024-04-192-0/+17
| | | | | | | | | | | | | | Makes it possible to catch errors not reported by sphinx, such as idle spaces. After customization, this should be used to enforce our syntax conventions, such as two spaces after a "-" character to introduce a list item. Just run "make sphinx-lint". (From yocto-docs rev: a735549a764f7cfebdc7534761b4d75dc523371a) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* manuals: fix duplicate "stylecheck" targetMichael Opdenacker2024-04-191-4/+0
| | | | | | | | (From yocto-docs rev: 9247fd612db9e551eb58dbe41d31e460f0ad7d72) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* manuals: refer to new yocto-patches mailing list wherever appropriateQuentin Schulz2024-04-192-1/+4
| | | | | | | | | | | | | | There's a new yocto-patches mailing list available for all layers that do not have their own mailing list. c.f. https://lists.yoctoproject.org/g/yocto/topic/105197684 Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: d7fc3e978440d9f5724cbce85de000317a3e0783) 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>
* docs: conf.py: properly escape backslashes for latex_elementsQuentin Schulz2024-04-191-2/+2
| | | | | | | | | | | | | | | | | | | | | There are some syntax warnings returned by Python: """ yocto-docs/documentation/conf.py:162: SyntaxWarning: invalid escape sequence '\P' 'passoptionstopackages': '\PassOptionsToPackage{bookmarksdepth=5}{hyperref}', yocto-docs/documentation/conf.py:163: SyntaxWarning: invalid escape sequence '\s' 'preamble': '\setcounter{tocdepth}{2}', """ Backslashes must be doubled in Python string literals to avoid interpretation as escape sequence, c.f. https://www.sphinx-doc.org/en/master/latex.html#module-latex. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 037f99339a4bae60f41f89df37911690b507c9a1) 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>
* release-notes-4.0.17: reorder CVEsLee Chee Yang2024-04-191-6/+6
| | | | | | | | | | | reorder CVEs from alphabetical order to numerical order, align it with text based release notes. (From yocto-docs rev: a2ce17f656758db737c398263efa594604ca2271) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* dev-manual: improve descriptions of 'bitbake -S printdiff'Alexander Kanavin2024-04-052-7/+13
| | | | | | | | | | | Try to particularly emphasize that it can be used to find out why something rebuilds when it shouldn't. (From yocto-docs rev: 1cd543e62e8f1b65e65108d919c2f481001e044c) Signed-off-by: Alexander Kanavin <alex@linutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: add documentation of the variable SPDX_NAMESPACE_PREFIXBELOUARGA Mohamed2024-04-051-0/+5
| | | | | | | | | | | The documentation of the variable SPDX_NAMESPACE_PREFIX does not exist. This variable is used to change the prefix of some links in SPDX docs. (From yocto-docs rev: 0055b7ea1cdf72359695e08fe6d2ca9a405fba51) Signed-off-by: BELOUARGA Mohamed <m.belouarga@technologyandstrategy.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* profile-manual: usage.rst: further style improvementsMichael Opdenacker2024-04-053-173/+187
| | | | | | | | | According to errors reported by "make stylecheck" (From yocto-docs rev: b3aaf4523190f7528d49c29a9aea234bb1647eae) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* contributor-guide: be more specific about meta-* treesMartin Jansa2024-04-051-1/+1
| | | | | | | | | | | | * this is often confused to apply for e.g. meta-oe as well where it doesn't apply as meta-oe has own ML mentioned in README. (From yocto-docs rev: 98102408fe5468529e040a138f09c8fbc5fe065a) Signed-off-by: Martin Jansa <martin.jansa@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* migration-guides: add release notes for 4.0.17Lee Chee Yang2024-04-052-0/+239
| | | | | | | | (From yocto-docs rev: 8267ccacea77a657cf92bcd2b48bec5f2ef61849) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* profile-manual: usage.rst: fix reference to bug reportMichael Opdenacker2024-04-051-3/+3
| | | | | | | | | Allowing to remove nested parentheses in the text! (From yocto-docs rev: a0ba062f8b31426f80ccd760e29b054405ee2a8e) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* manuals: use "manual page(s)"Michael Opdenacker2024-04-053-16/+16
| | | | | | | | | | Instead of "manpage(s)" or "man page(s)". To address one of the errors reported by "make stylecheck" (From yocto-docs rev: f6e69f8877d1d33200993f21b448e7fa3cf7859b) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* profile-manual: usage.rst: formatting fixesMichael Opdenacker2024-04-051-235/+238
| | | | | | | | | Plus a few text styling improvements, some reported by "make stylecheck" (From yocto-docs rev: ce0e83716197773d8eae0c2f0edc1cf290ebd60f) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* manuals: add initial stylechecks with ValeMichael Opdenacker2024-04-057-1/+58
| | | | | | | | | | | | | Use the "Vale" (https://vale.sh) tool to perform text style checks Run "make stylecheck" to run the checks. This just checks the text, not the Sphinx syntax style choices. (From yocto-docs rev: e3e4ba2aa963d4d178c4e9e842e66f4ee4bd3736) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Suggested-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* manuals: document VIRTUAL-RUNTIME variablesMichael Opdenacker2024-03-252-9/+36
| | | | | | | | | | | | | | Document the convention to use variables prefixed by VIRTUAL_RUNTIME. Add references to the new term where possible. Another reason is that such variables are recommended in a warning issued by meta/classes-global/insane.bbclass (From yocto-docs rev: db88c2021062c95fe49b54351952753390d45a6a) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Tim Orling <ticotimo@gmail.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* contributor-guide: add notes for testsSimone Weiß2024-03-251-0/+32
| | | | | | | | | | | | This adds some hints that and how changes should be tested when contributing. Fixes [YOCTO #15412] (From yocto-docs rev: 649843f4d20d1d840e1c6c4ce15e89b3a8508e0f) Signed-off-by: Simone Weiß <simone.p.weiss@posteo.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* manuals: replace hyphens with em dashesMichael Opdenacker2024-03-2523-92/+91
| | | | | | | | | | | | | | | | | | | | 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: a0d93ea1ddfdfbcde8dac3aa328307be778f9e3c) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* dev-manual: packages: fix capitalizationMichael Opdenacker2024-03-251-1/+1
| | | | | | | | | | | | Using "PR service" instead of "PR Service", like in the other two instances in this document. (From yocto-docs rev: ef8b7d30738fe8ae6702da111bbafdc0e00e86bf) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Reviewed-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: variables: adding multiple groups in GROUPADD_PARAMGeoff Parker2024-03-251-0/+8
| | | | | | | | | | | Add missing documentation on how to add multiple groups with a single GROUPADD_PARAM:${PN} (From yocto-docs rev: 46f82dcb3b4042491efd44b9c15a06e3c910ec85) Signed-off-by: Geoff Parker <geoffrey.parker@arthrex.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: variables: correct sdk installation default pathJohan Bezem2024-03-252-2/+6
| | | | | | | | | | | | | | | | | | The SDKPATH variable seems mistakenly identified as the default path where the SDK will be installed by the generated installation script, unless option '-d' or a manual input overrides this default. The intended variable is SDKPATHINSTALL. SDKPATH indicates where the SDK is being composed and built. The definitions have been added/updated. (From yocto-docs rev: f7ce2abbdcff625356b337137e91f642ff6a4dc2) Signed-off-by: Johan Bezem <jbezem.extern@arri.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2025-08-04 11:58:50 +0000