summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/classes.rst
Commit message (Collapse)AuthorAgeFilesLines
* ref-manual: Update how to set a useradd passwordDaiane Angolini2021-10-221-5/+11
| | | | | | | | | | Partial fix for [YOCTO 14605] (From yocto-docs rev: d9c7fba68ca7c901e9e7064fee2989d834d4684c) 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: document "reproducible_build" class and SOURCE_DATE_EPOCHMichael Opdenacker2021-10-201-0/+12
| | | | | | | (From yocto-docs rev: ab6d3dbf57cac560b9b142cf5becf11d3edf09b7) Signed-off-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: 46bfdb0b4ae2cb834589ef09436b120715663a31) 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>
* docs: remove image-mklibs referencesPatrick Williams2021-07-101-15/+1
| | | | | | | | | | | | | | | 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>
* docs: replace ``FOO`` by :term:`FOO` where possibleQuentin Schulz2021-06-191-37/+37
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* Remove Clutter referencesRoss Burton2021-06-051-15/+0
| | | | | | | | | | | The clutter class and image have been moved to meta-gnome before it is finally obsoleted for good, so remove mentions from the documentation. (From yocto-docs rev: adab5d0047354b5a1b11c2ece48abd8f295f69b0) 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>
* ref-manual: simplify styleMichael Opdenacker2021-05-221-6/+6
| | | | | | | (From yocto-docs rev: 657a7f54856afd6fec7f2cb0b5f12b4b2d24adb7) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: reduce verbosity related to "the following" expressionMichael Opdenacker2021-05-131-1/+1
| | | | | | | (From yocto-docs rev: da9d1cfb5c084d172eff3cb10ec3631dd8266260) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: reduce verbosity with "worry about" expressionMichael Opdenacker2021-05-131-2/+2
| | | | | | | | (From yocto-docs rev: 6c65f5f350cdc79a435deb20c48d861d9f4c5c14) 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>
* manuals: code insertion simplification over two linesMichael Opdenacker2021-04-231-58/+29
| | | | | | | | | | | | | | | This simplifies paragraphs ending with a colon and followed by code insertion. Automatically substituted through the command: sed -i -z "s/:\n\s*::/::/g" file.rst This generates identical HTML output. (From yocto-docs rev: 28e2192a7c12d64b68061138a9f6c796453eebb1) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add python3targetconfig class and remove python 2 referencesPaul Eggleton2021-04-151-51/+16
| | | | | | | | | | Add the recently added python3targetconfig class. Also, we no longer have the python 2 classes, remove all references to those. (From yocto-docs rev: c63d88656e2fc5361c512d4d9b426260c3e339f3) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: Fix typos and spacingMichael Opdenacker2021-04-061-1/+1
| | | | | | | | | | Fix double words, punctuation spacing issues, spacing issues, "its" instead of "it's", and other trivial issues. (From yocto-docs rev: 56eb1f340a7af112e62c1d8ad02d4bec0ad88313) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/ref-classes: update kernel-fitimage with Initramfs bundle and ↵Abdellatif El Khlifi2021-01-201-5/+27
| | | | | | | | | | | | | boot script This commit adds the description of the Initramfs bundle and boot script new features implemented in the kernel-fitimage class. Change-Id: Ifffa6b850308aa7ceadc4f117806cffad0137137 (From yocto-docs rev: a55c16555366c0adbf4a087b86574b07972cbc52) Signed-off-by: Abdellatif El Khlifi <abdellatif.elkhlifi@arm.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Fix a Concpets -> Concepts typoYoann Congal2021-01-151-1/+1
| | | | | | | (From yocto-docs rev: 78bdf1c25c5c546c35b5a0d246aa1bbd70d5eace) Signed-off-by: Yoann Congal <yoann.congal@smile.fr> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Use https links where possiblePaul Barker2020-12-241-2/+2
| | | | | | | (From yocto-docs rev: cd4c5e9928866f910ac97cf3e0612e6245da30bd) Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: use consistent capitalisation of U-BootPaul Eggleton2020-12-241-3/+3
| | | | | | | | | Change all instances of U-boot to U-Boot. (From yocto-docs rev: 153c60fd9f2807c8e98105bcd4384e52e2adaa1a) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* classes: minor corrections to kernel-fitimage sectionPaul Eggleton2020-12-241-5/+5
| | | | | | | | | Minor syntax and formatting corrections. (From yocto-docs rev: eda1fae0dc8670ff22f10b591ce14b9bbf0455ce) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: remove 'ref' from filenamesNicolas Dechesne2020-12-091-0/+2898
All filenames duplicate the 'manual name', which is not needed, and make all references longer than they should. Rename all files to be as consise as possible, and fix all references (From yocto-docs rev: bb7e4783f45a5f67e6e4b39968f3512f43738833) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>