summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
* release-notes: additional features and one known issue for 5.0Paul Eggleton2024-04-161-5/+71
| | | | | | | | | | | | Add additional features and tweak some existing entries. Also add one known issue for gpgme. (From yocto-docs rev: 0cdc0afd3332459d30cfc8f4c2e62bdcc23f5ed5) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration: extend migration guide for 5.0Paul Eggleton2024-04-161-8/+76
| | | | | | | | | | Add a few missing entries based upon combing through the release commits, as well as minor tweaks to existing items. (From yocto-docs rev: 0680ee719edaa31a52f9cb7bd5138b402b1b26ce) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* release-notes: add CVEs, recipe upgrades and contributors for 5.0Paul Eggleton2024-04-161-1/+562
| | | | | | | | | | | | * Add CVEs from commits * Add recipe upgrades using layer index branch comparison * Add contributors from commits (From yocto-docs rev: 4cf6b62939c226fb9c49b7d61f3d95075a9cd8bd) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: update custom distribution sectionPaul Eggleton2024-04-161-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: 3dc812e7255ba7c0ddd7b43b9b1319ea4ef3161e) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: update reference to sstate-cache-management scriptPaul Eggleton2024-04-161-1/+1
| | | | | | | | | | | | | * Script is now .py * In the example, we would most likely be within the build directory already, so the path would be just "sstate-cache" not "build/sstate-cache" (From yocto-docs rev: a655ef8f5fee98e55277cbd40a092fcae697cbae) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: variables: add TARGET_DBGSRC_DIRPaul Eggleton2024-04-161-0/+4
| | | | | | | | | | New variable in 5.0. (From yocto-docs rev: 047780931ec8156d77ec10f3f051bd98b83714f8) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: classes: cve_check: add note about remote patchesPaul Eggleton2024-04-161-0/+7
| | | | | | | | | | Document the change in behaviour in 5.0. (From yocto-docs rev: f7a223d4e78bee67107fa47e147208f57a2d9521) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add new python classesPaul Eggleton2024-04-161-0/+18
| | | | | | | | | | | Add brief documentation of python_maturin and python_mesonpy classes that were added in 5.0. (From yocto-docs rev: ce7dd61a928dec778a5df538701dfdeb26db0ebd) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add virtual-slash QA checkPaul Eggleton2024-04-162-0/+14
| | | | | | | | | | | Add the new virtual-slash QA check to the insane class section and the QA checks section. (From yocto-docs rev: fdca0217558185eca67f7ec04b9d282b7819d107) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: variables: Update default INHERIT_DISTRO valueGeoff Parker2024-04-161-1/+1
| | | | | | | | | | | Add remove-libtool and create-spdx to INHERIT_DISTRO defaults per meta/conf/distro/defaultsetup.conf (From yocto-docs rev: a5193a97d774dd6aad09fc756fcd362638d7d2fe) Signed-off-by: Geoff Parker <geoffrey.parker@arthrex.com> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* release-notes-5.0: various additions and improvementsLee Chee Yang2024-04-161-2/+25
| | | | | | | | (From yocto-docs rev: 4b839c460867d685584134dbd322cd9b20f2ae6d) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: release-notes-5.0: update docs highlightsMichael Opdenacker2024-04-121-0/+3
| | | | | | | | | | Mention the new section about variable context in the BitBake manual. (From yocto-docs rev: a8b81d8a7974207e2a9fe63da4a0c239132818ed) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> CC: Simone Weiß <simone.p.weiss@posteo.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual/debugging: mention new ``taskexp_ncurses`` optionMichael Opdenacker2024-04-121-4/+8
| | | | | | | | (From yocto-docs rev: 301c802a92a2c53c3d0c755c31a6e09130956fde) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Suggested_by: Reyna, David <david.reyna@windriver.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: remove tab charactersMichael Opdenacker2024-04-127-103/+103
| | | | | | | | | | | | | 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: 20e9c0c9fad3109567948af6bc40bb0fa2a5552b) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* release-notes-5.0: documentation highlightsMichael Opdenacker2024-04-121-0/+11
| | | | | | | (From yocto-docs rev: d8f63d3c83e33793e6249fd660ef7b75d87e12db) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* release-notes-5.0: mention cmake-qemu.bbclassJoao Marcos Costa2024-04-121-0/+3
| | | | | | | | | | Mention this new class in QEMU section. (From yocto-docs rev: ddd0e0817a12ebbd3d33d20e20d2407ac1e63b71) Signed-off-by: Joao Marcos Costa <joaomarcos.costa@bootlin.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* release-notes-5.0: add updatesJoao Marcos Costa2024-04-121-1/+124
| | | | | | | | | | | | | | | | | | | | | | - add new core recipes section - add new variables - add arch-specific enhancements - add kernel-related enhancements - add qemu enhancements - add rust enhancements - add wic enhancements - add sdk-related improvements - add testing enhancements - add utility script changes - add packaging changes - add bitbake improvements - add miscellaneous changes (From yocto-docs rev: 72a80395199dd8a5d757b9e67629e1bb849273f1) Signed-off-by: Joao Marcos Costa <joaomarcos.costa@bootlin.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables: add new variables for v5.0Joao Marcos Costa2024-04-121-0/+16
| | | | | | | | | | Add variables newly referenced in release-notes-5.0. (From yocto-docs rev: 1d064cf0e260a1271c2fad7cd01bb154361f6691) Signed-off-by: Joao Marcos Costa <joaomarcos.costa@bootlin.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* release-notes-5.0: document some cve, strace and qa changesYoann Congal2024-04-121-0/+17
| | | | | | | | | | | | | | This patch should cover those commits (from poky) : * 789b10030c6 (cve-update-nvd2-native: remove rejected cve from database, 2024-03-15) * 19f27037b2b (cve-update-nvd2-native: add an age threshold for incremental update, 2024-03-13) * 6ce61b43570 (strace: disable bluetooth support by default, 2023-12-13) * 381ef628fab (ref-manual: add documentation for the unimplemented-ptest qa warning, 2023-10-10) (From yocto-docs rev: da44182aa084378dbf7a04bb010cbd87e508a607) Signed-off-by: Yoann Congal <yoann.congal@smile.fr> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: variables: document CVE_DB_INCR_UPDATE_AGE_THRES variableYoann Congal2024-04-121-0/+5
| | | | | | | | (From yocto-docs rev: 7f1db309205f9c3cb0b44b6d75d6c65c928787e2) Signed-off-by: Yoann Congal <yoann.congal@smile.fr> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: join mkdir commands with -pJörg Sommer2024-04-081-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: 92806d2ab1f909eef9ccc532958a7ced6262b9b0) Signed-off-by: Jörg Sommer <joerg.sommer@navimatix.de> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: add missing opening tag colonMichael Opdenacker2024-04-082-2/+2
| | | | | | | | | As reported by "make sphinx-lint" (From yocto-docs rev: 7e8d8d6d47da61457798e90b1d53f3082fe76668) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: fix incorrect double backticksMichael Opdenacker2024-04-082-2/+2
| | | | | | | | | As reported by "make sphinx-lint" (From yocto-docs rev: 1601bf2d294c3a8e7c4c654539c8a4da3ed054d0) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: fix trailing spacesMichael Opdenacker2024-04-0811-45/+45
| | | | | | | | | Fixing errors reported by "make sphinx-lint" (From yocto-docs rev: ef6b650c31c4320314564bb85a45eebde3fd98c1) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add initial sphinx-lint supportMichael Opdenacker2024-04-082-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: 9e1aeeddca06cb7d65631010ba0eebdcd8ecf9ee) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* release-notes updates for 5.0Joao Marcos Costa2024-04-081-0/+33
| | | | | | | | | | | | | | | | | | | | | | | | List systemd changes Add PACKAGECONFIG-related changes, as well as systemd-boot-native, to 'Miscellaneous changes section'. Mention the licensing changes in systemd and libsystemd. Add changes to wic Summarize changes in 'wic Image Creator enhancements' item. Add Go language upgrade There were multiple bumps between Scarthgap and Nanbield, but overall the version was upgraded from 1.20.10 (in Nanbield) to 1.22.1 (in Scarthgap). Mention the new class 'go-vendor' in 'Miscellaneous changes'. Add create_go.py to script changes Mention this new script, at recipetool, in 'Utility script changes'. (From yocto-docs rev: 3e24a1cf2f2089beedad11b91fc11b8b402caf87) Signed-off-by: Joao Marcos Costa <joaomarcos.costa@bootlin.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration updates for 5.0Joao Marcos Costa2024-04-081-2/+31
| | | | | | | | | | | | | | | | | | | | | | | | | List removed recipes Fill the 'Removed recipes' section for the upcoming release 5.0 Leave some sections empty Only mention that no classes were removed and no variables were removed in the upcoming release 5.0. List systemd changes Mention the nss-resolve related changes. Add Go language changes List removed variables Fill the 'Removed variables' section for the upcoming release 5.0 Add QEMU changes Add Miscellaneous changes (From yocto-docs rev: cbc0b6fa333984c0c49f3c94daffd496815b5d68) Signed-off-by: Joao Marcos Costa <joaomarcos.costa@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* classes: document new go-vendor classJoao Marcos Costa2024-04-081-0/+14
| | | | | | | | | | | A reference to this class in the release notes will be added in a follow-up commit. (From yocto-docs rev: bfd38ad1056ded01a25acfa37e89302df2290ddf) Signed-off-by: Joao Marcos Costa <joaomarcos.costa@bootlin.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: add release notes for 4.3.4Lee Chee Yang2024-04-082-0/+207
| | | | | | | | (From yocto-docs rev: 26a94025d4ce445495e83565b4d53bda5b7aeef6) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: fix duplicate "stylecheck" targetMichael Opdenacker2024-04-081-4/+0
| | | | | | | | (From yocto-docs rev: f19e4231b1982f97ffd210b76978404fe1f2893b) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: refer to new yocto-patches mailing list wherever appropriateQuentin Schulz2024-04-082-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: ac512f76b93a20507a6835ddafa954b4ae45e268) 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>
* docs: conf.py: properly escape backslashes for latex_elementsQuentin Schulz2024-04-081-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: a78d9bde7f90f860aa969b7d8e47350de9106183) 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>
* release-notes-4.0.17: reorder CVEsLee Chee Yang2024-04-081-6/+6
| | | | | | | | | | | reorder CVEs from alphabetical order to numerical order, align it with text based release notes. (From yocto-docs rev: da670cfe7c22ece8925cb620f52832cc1c34e736) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: improve descriptions of 'bitbake -S printdiff'Alexander Kanavin2024-03-192-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: cfaf2707b4a77888316d5eb24bf41ccc21e2c12b) 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>
* dev/ref-manual: document conf-summary.txt together with conf-notes.txtAlexander Kanavin2024-03-192-6/+7
| | | | | | | | (From yocto-docs rev: b92f2eac3b7455ebfc87f668b9442122dbf1c66f) 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>
* sdk-manual: correctly describe separate build-sysroots tasks in direct sdk ↵Alexander Kanavin2024-03-191-2/+6
| | | | | | | | | | | | | workflows They were separated in https://git.yoctoproject.org/poky/commit/?id=63e53fb8b60d38315015844bd3357fa1649cd639 (From yocto-docs rev: b880ac9498764027de435103d493f34adf68dc13) 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>
* ref-manual: add documentation of the variable SPDX_NAMESPACE_PREFIXBELOUARGA Mohamed2024-03-191-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: 85c56d8f7f65875628ab63abf661705b26f55224) Signed-off-by: BELOUARGA Mohamed <m.belouarga@technologyandstrategy.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* profile-manual: usage.rst: further style improvementsMichael Opdenacker2024-03-193-173/+187
| | | | | | | | | According to errors reported by "make stylecheck" (From yocto-docs rev: fc808b2dca4321209bfa6206d9e43aa1a5a0c5b8) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add initial stylechecks with ValeMichael Opdenacker2024-03-191-0/+4
| | | | | | | | | | | | | 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: 51b1f9a4d5aa02d337b105633de38e18b923a13a) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Suggested-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide: be more specific about meta-* treesMartin Jansa2024-03-191-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: 63be0814a7ecf38c570b6d776f62b7c7803eb299) Signed-off-by: Martin Jansa <martin.jansa@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: add release notes for 4.0.17Lee Chee Yang2024-03-192-0/+239
| | | | | | | | (From yocto-docs rev: 224de9dfb6238677ecff715e1d57376487b6517f) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: draft notes for upcoming release 5.0Michael Opdenacker2024-03-194-0/+181
| | | | | | | (From yocto-docs rev: e81c4da57aacce4a5c9e7b36ad4f911116747dd1) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Makefile: remove releases.rst in "make clean"Michael Opdenacker2024-03-191-1/+1
| | | | | | | | | releases.rst is generated by the set_versions.py script (From yocto-docs rev: 4b7773f59bab2d653d07b7e06cd21745b646b604) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* profile-manual: usage.rst: fix reference to bug reportMichael Opdenacker2024-03-191-3/+3
| | | | | | | | | Allowing to remove nested parentheses in the text! (From yocto-docs rev: 7cfa49fe17a8a20a8d4671c0daf1820c3cd69952) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: use "manual page(s)"Michael Opdenacker2024-03-193-16/+16
| | | | | | | | | | Instead of "manpage(s)" or "man page(s)". To address one of the errors reported by "make stylecheck" (From yocto-docs rev: 86f5f5cd385f09c48c4cf0b1ab222d6e1e7c7e54) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* profile-manual: usage.rst: formatting fixesMichael Opdenacker2024-03-191-232/+235
| | | | | | | | | Plus a few text styling improvements, some reported by "make stylecheck" (From yocto-docs rev: c29a1bf4dd5223e4af9c1be5a8a8ea6a88bb7a58) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add initial stylechecks with ValeMichael Opdenacker2024-03-197-1/+54
| | | | | | | | | | | | | 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: d145e1dc45dc0792c8b8f7e73500b56face1e710) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Suggested-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: classes: update description of class 'image_types'Ulrich Ölmann2024-03-191-2/+6
| | | | | | | | | | | | | Cite usage of IMGCLASSES variable in class 'image' as found in OE-Core's commit [1]. [1] 451363438d38 ("classes/recipes: Switch to use inherit_defer") (From yocto-docs rev: 674f376ece98466d3498459d5b5428a8bfbd5112) 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>
* dev-manual: bmaptool: renameTrevor Woerner2024-03-062-11/+11
| | | | | | | | | | | | | | | What was previously known variously as Bmaptool, bmaptools, bmap-tool, and/or bmap-tools has been updated to the singular name: bmaptool. Update all references to suit. Since we are not in charge of debian's package naming policy, any references that relate to debian package(s) will stay as "bmap-tools". (From yocto-docs rev: 9c1505eabd69af548652381cf996d44f40a4fa8a) Signed-off-by: Trevor Woerner <twoerner@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: document VIRTUAL-RUNTIME variablesMichael Opdenacker2024-03-062-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: 11e1ba97edac979868f199e43c1004db6678044c) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Tim Orling <ticotimo@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2025-07-06 11:57:14 +0000