summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/classes.rst
Commit message (Collapse)AuthorAgeFilesLines
...
* ref-manual: classes.rst: improve documentation for cve-check.bbclassMikko Rapeli2022-10-281-2/+50
| | | | | | | | | | | It is a quite important tool for maintaining yocto based products so documentation should include the best practices. (From yocto-docs rev: 3f7d09fc3c96f29ab80a2cb893c9b4b19a75a769) 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>
* ref-manual: classes.rst: add links to all references to a classMichael Opdenacker2022-10-251-227/+225
| | | | | | | | | | | | | | | | | | | | | | | | [YOCTO #14508] Reported-by: Quentin Schulz <foss@0leil.net> (From yocto-docs rev: 664b658d9d23bb97b236bc0d09c9d3f118c582fc) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> -- Doing this to consistently replace any reference to a class by the corresponding link. This is a bit trivial within the declaration of a class, but helps making sure that this rule applies everywhere. This helps for example to rename or remove classes from the documentation. See https://bugzilla.yoctoproject.org/show_bug.cgi?id=14508 As this change is time consuming, submitting the first part of it as an RFC, to double check there is an agreement on doing this. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: fix misc typosMichael Opdenacker2022-10-191-1/+1
| | | | | | | (From yocto-docs rev: 988efd0d1663e4369043c5b53d7e1dcd9e54d3cd) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add section for create-spdx classPaul Eggleton2022-10-191-0/+8
| | | | | | | | | | | create-spdx was added in the honister release. This is a stub since I unfortunately don't have time to fully document this class and related variables, hopefully someone else can expand it in future. (From yocto-docs rev: 5a4aa9dca1468d56ab5ec2c3a5ebf1ea364df5d0) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Update documentation for classes splitPaul Eggleton2022-10-191-8/+12
| | | | | | | | | | | | | | | | | | * Make reference to meta/classes* instead of just meta/classes * Update each reference to the path where the class has moved * Add a brief explanation to the classes reference explaining the split * Add a note to INHERIT, INHERIT_DISTRO, IMAGE_CLASSES and USER_CLASSES variable glossary entries mentioning where the specified classes must be located. I contemplated adding the same note to PACKAGE_CLASSES but decided against it, as it has a very specific usage and such a note might distract from the narrative of that entry. * Also trim the IMAGE_CLASSES entry which was quite outdated. * INHERIT += no longer works with testimage so drop the note about that (From yocto-docs rev: e76bed00b452d3049f6c22afbfb980b557a141bd) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: remove reference to testimage-auto classPaul Eggleton2022-10-191-8/+9
| | | | | | | | | testimage-auto was removed in the thud release. (From yocto-docs rev: 618351169c09470280aeee53a63aba88788efc4b) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: update pypi documentation for CVE_PRODUCT default in 4.1Paul Eggleton2022-10-191-1/+2
| | | | | | | | | | In 4.1 the pypi class has been updated to set a default CVE_PRODUCT value. (From yocto-docs rev: e4b25d6790c3966bad3c63818729c1baaf2b3ca9) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add pypi classPaul Eggleton2022-10-191-0/+15
| | | | | | | | | Add missing documentation for the pypi class. (From yocto-docs rev: d387ca891ad3a7d00ec3cb5f994dc5832c885d54) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: update buildpaths QA check documentationPaul Eggleton2022-10-191-2/+2
| | | | | | | | | | | The buildpaths QA check is now practically usable and enabled by default, so update the comment and add a section with the warning message since users may start seeing it in their builds. (From yocto-docs rev: a14997e3b8576cd1a6e1c38d13b5b8e05ac03b88) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: document new github-releases classPaul Eggleton2022-10-191-0/+14
| | | | | | | | | Newly added class in 4.1. (From yocto-docs rev: 391750e417d7a6b88222e03aa0a57ea87d9f618a) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: expand documentation on image-buildinfo classPaul Eggleton2022-10-191-2/+16
| | | | | | | | | | | Expand the documentation on the image-buildinfo class, and add variable glossary entries for IMAGE_BUILDINFO_FILE, IMAGE_BUILDINFO_VARS and SDK_BUILDINFO_FILE (latter is new in 4.1). (From yocto-docs rev: f69b2f614aaa56a19432538cb1adf33a441ea31d) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add references to the "do_devshell" taskMichael Opdenacker2022-10-071-1/+1
| | | | | | | | | [YOCTO #14508] Reported-by: Quentin Schulz <foss@0leil.net> (From yocto-docs rev: 53141101fc1a8dc8b4007adcded3c7c6b9738f48) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add references to "do_populate_sysroot" taskMichael Opdenacker2022-10-071-1/+1
| | | | | | | | | [YOCTO #14508] Reported-by: Quentin Schulz <foss@0leil.net> (From yocto-docs rev: a010e2eafa6754c46faac6f6dfd02dc6152d274f) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add references to "do_package_write_*" tasksMichael Opdenacker2022-10-071-1/+1
| | | | | | | | | | | | 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>
* manuals: add reference to the "do_compile" taskMichael Opdenacker2022-10-071-1/+1
| | | | | | | | | [YOCTO #14508] Reported-by: Quentin Schulz <foss@0leil.net> (From yocto-docs rev: e88f11002032e30bbe2dd0049e307a431a70aaef) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add reference to the "do_install" taskMichael Opdenacker2022-10-071-4/+4
| | | | | | | | | [YOCTO #14508] (From yocto-docs rev: 933ad27b81dfc4a28e7c48ca7bb2d1363e8c037f) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: improve initramfs detailsMichael Opdenacker2022-10-071-3/+3
| | | | | | | | | | | | | | - 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>
* manuals: fix typos in the context of 'icecc' & clean up whitespacesUlrich Ölmann2022-09-241-7/+8
| | | | | | | | (From yocto-docs rev: cce3eece0886b5446774e6a5cc57c28d13c58fdd) 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>
* documentation: remove obsolete PEP517_BUILD_APIRoss Burton2022-07-151-3/+1
| | | | | | | | | | | | This variable has been obsoleted, so remove it from the documentation. (From yocto-docs rev: 30ed4323e7fb482e4f6f47755314354a2e5e3871) (From yocto-docs rev: afa895871e8ec18f4861f48f70b8a54cc2e4cb98) Signed-off-by: Ross Burton <ross.burton@arm.com> Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: replace hyphens with em dashesMichael Opdenacker2022-06-271-3/+3
| | | | | | | | | | | | | | | | | | | 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>
* manuals: correct and improve descriptions of AutotoolsMichael Opdenacker2022-04-271-1/+2
| | | | | | | (From yocto-docs rev: c7cb693673566ec12b95c568945b514ed0e18522) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add empty-dirs QA check and QA_EMPTY_DIRS*Paul Eggleton2022-04-251-0/+5
| | | | | | | | | This check is new in kirkstone. (From yocto-docs rev: baa483e75538013be3261f8c115b8a5364b24c60) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add a note about hard-coded passwordsPaul Eggleton2022-04-251-0/+8
| | | | | | | | | | | | It seems prudent to point out that hard-coding passwords in the manner detailed in the example is not a good idea in production. This type of mistake has unfortunately been made by many device vendors (outside of the Yocto Project context) leading to security vulnerabilities. (From yocto-docs rev: 1d07dba9423ae0a841eccb58c297e31b63c3965d) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: update Python class documentationRoss Burton2022-03-311-30/+41
| | | | | | | | | | | Add new PEP517_* variables, remove obsolete variables, and update for renamed classes. (From yocto-docs rev: 3984d4d0804125ba6fba7bf712edb81f97b4bec7) Signed-off-by: Ross Burton <ross.burton@arm.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Update documentation for Python packaging changesRoss Burton2022-03-161-17/+28
| | | | | | | | | | | A number of classes and variables have been renamed, so update the documentation as needed. (From yocto-docs rev: 35b2e1757f5f2f09bb899ed24ffea50e5041b471) Signed-off-by: Ross Burton <ross.burton@arm.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: inclusive language updatesMichael Opdenacker2022-03-161-4/+4
| | | | | | | | | | | | | 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>
* docs: update examples to add branch info to git URIsMichael Opdenacker2022-03-161-3/+2
| | | | | | | | | | 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>
* documentation: Update for skip_recipe renameSaul Wold2022-03-161-17/+0
| | | | | | | | | | | | This change better aligns the name of the variable with its purpose. Since we removed the older class, the associated documentation is also removed. (From yocto-docs rev: aa136a0fb552339db5475fff7947d2248f8af3e1) Signed-off-by: Saul Wold <saul.wold@windriver.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: remove references to prelink supportMichael Opdenacker2022-03-041-15/+0
| | | | | | | | | | 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>
* ref-manual: classes: provide command with ready-to-use passwordQuentin Schulz2022-03-041-4/+3
| | | | | | | | | | | | | | mkpasswd output requires to be escaped before being used as password in a Bitbake variable. It was explicitly stated after the command, but to be sure it's not missed, let's give the printf command which does escape the string for us. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 13064e7bea18e999d4a294e298a7980a4dcbe69e) 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: add new python packaging classesTim Orling2022-03-041-0/+53
| | | | | | | | | | | | | Add the new classes used for Python packaging: * flit_core * pip_install_wheel * setuptools_build_meta (From yocto-docs rev: f78fe71f634cbf39857c42e90f8c16e511ba2076) Signed-off-by: Tim Orling <tim.orling@konsulko.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: ref-manual: remove distutils* from classesTim Orling2022-03-041-29/+0
| | | | | | | | | | | The distutils*.bbclasses have been removed from oe-core and moved to meta-python, so remove them from ref-manual/classes.rst. (From yocto-docs rev: 9da8fd7d436ac3eb3b66409cf0e53218d6e41822) Signed-off-by: Tim Orling <tim.orling@konsulko.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: update setuptools3 classTim Orling2022-03-041-2/+20
| | | | | | | | | | | Add notes to inform about the new `wheel` behavior of the setuptools3.bbclass. (From yocto-docs rev: 4f19c8218f7c960d1ad0288d76d5394b6595c3f1) Signed-off-by: Tim Orling <tim.orling@konsulko.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add usage details about ccache.bbclassMichael Opdenacker2022-02-031-4/+9
| | | | | | | (From yocto-docs rev: c06e5710b139c01347b9cd2113dde0961f483995) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/classes.rst: add setuptools3-baseTim Orling2022-01-171-0/+19
| | | | | | | | | | | | | | Add setuptools3-base class Deprecate distutils3* classes. [YOCTO #14610] (From yocto-docs rev: 0e9838e5a2096932d081a9a05a25c4fa0d6dc714) Signed-off-by: Tim Orling <tim.orling@konsulko.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: replace "rootfs" by "root filesystem"Michael Opdenacker2022-01-071-5/+5
| | | | | | | | | | 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>
* ref-manual: add overlayfs-etc classVyacheslav Yurkov2022-01-071-0/+46
| | | | | | | | (From yocto-docs rev: c11da26609e02f0c0b43efacb4642141d990ebaa) Signed-off-by: Vyacheslav Yurkov <uvv.mail@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* make the documentation a bit more inclusiveQuentin Schulz2021-12-131-7/+7
| | | | | | | | | | | | | | | 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>
* ref-manual: add more class referencesMichael Opdenacker2021-12-131-2/+2
| | | | | | | (From yocto-docs rev: f4610b060968c481c68d0411b82201c302050b71) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add hyperlinks to files in meta-skeletonMichael Opdenacker2021-12-131-3/+2
| | | | | | | | | | | 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>
* ref-manual: update overlayfs classVyacheslav Yurkov2021-11-071-1/+15
| | | | | | | | | | | Describe how to use a generated helper service to set up a proper systemd dependency chain. (From yocto-docs rev: c8c1f7e852830dae4468da70e1ac732d7bbce06f) Signed-off-by: Vyacheslav Yurkov <uvv.mail@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Update how to set a useradd passwordDaiane Angolini2021-10-221-5/+11
| | | | | | | | | | Partial fix for [YOCTO 14605] (From yocto-docs rev: 3f3e5574ac9801ad92940168b61b532e0bd53a80) Signed-off-by: Daiane Angolini <daiane.angolini@foundries.io> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: remove meta classPaul Eggleton2021-10-201-9/+0
| | | | | | | | | This was recently removed so remove the reference to it. (From yocto-docs rev: 53f52adf212e35e7588a90e94b03b5cfae6f867c) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: font fixesMichael Opdenacker2021-10-081-2/+2
| | | | | | | | | | | | | | 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>
* ref-manual: add overlayfs classVyacheslav Yurkov2021-09-181-0/+49
| | | | | | | | (From yocto-docs rev: 5bd2f3c0bbf4178e381aec2b7de57ef8289c2271) Signed-off-by: Vyacheslav Yurkov <uvv.mail@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: correct typo in "classes" section, "${BPN}/{PV}"Robert P. J. Day2021-09-181-1/+1
| | | | | | | | (From yocto-docs rev: 28a72c5a1cc873b455d7854065e1f999e6c5b7a5) 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>
* docs: fix new override syntax migrationQuentin Schulz2021-08-141-4/+4
| | | | | | | | | | Fix bits missed by the migration script. (From yocto-docs rev: 452e0c5067476fd2ce81f09e6c73da84ced4bbd0) 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>
* ref-manual: overrides syntax updatesMichael Opdenacker2021-08-141-7/+7
| | | | | | | | | Updated with openembedded-core/scripts/contrib/convert-overrides.py (From yocto-docs rev: 23ee6fbdf429d4cf1de4129e92dc7de4e6e9d184) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: further documentation for cve-checkMichael Opdenacker2021-08-101-0/+16
| | | | | | | | | | | | | 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>
* docs: replace remaining ``FOO`` by :term:`FOO`Quentin Schulz2021-07-161-5/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2025-10-05 03:00:49 +0000