summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/features.rst
Commit message (Collapse)AuthorAgeFilesLines
* ref-manual: add serial-autologin-root to IMAGE_FEATURES documentationPaul Eggleton2022-10-191-0/+6
| | | | | | | | | New IMAGE_FEATURES item in 4.1. (From yocto-docs rev: 0fdd9079743a4a4205afcaaaa783af855ce5f21f) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add missing featuresPaul Eggleton2022-10-191-0/+50
| | | | | | | | | | | | | | | Add missing IMAGE_FEATURES, DISTRO_FEATURES and MACHINE_FEATURES items. Additionally, add a note that DISTRO_FEATURES doesn't have any impact on the kernel configuration so that users are aware they have to take care of that as well. (I thought the same was true of MACHINE_FEATURES, but it seems we have a couple of isolated cases where that will adjust the kernel configuration - few enough that I suspect they might have slipped in and thus probably shouldn't be documented yet.) (From yocto-docs rev: 488a5896feefd6d0dbc197e7cc431b4d23085104) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: remove reference to largefile in DISTRO_FEATURESPaul Eggleton2022-10-191-3/+0
| | | | | | | | | This no longer does anything in 4.1. (From yocto-docs rev: a288b422cf9753a393e0c6791292ac5dad2fe732) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add a note to ssh-server-dropbear featurePaul Eggleton2022-10-191-0/+15
| | | | | | | | | | Add a note regarding the 4.1 change to add openssh-sftp-server as a recommends from ssh-server-dropbear. (From yocto-docs rev: dd4775d666ca8309ef029fd329a248397bcdedc6) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: features.rst: add missing default distro featuresMichael Opdenacker2022-09-241-3/+40
| | | | | | | | | | | | | | Document default machine features defined in Poky, and which were not listed in the documentation yet. Took the values of DISTRO_FEATURES_DEFAULT and POKY_DEFAULT_DISTRO_FEATURES: meta-poky/conf/distro/poky.conf:DISTRO_FEATURES ?= "${DISTRO_FEATURES_DEFAULT} ${POKY_DEFAULT_DISTRO_FEATURES}" Also explain that extra layers can define their own features. This addresses [YOCTO #14515] Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add numa to machine featuresJon Mason2022-08-311-0/+2
| | | | | | | | | | | numa is an existing machine feature, add it to the list so that users are aware of it. (From yocto-docs rev: 6022d15b8ee5e038d2f1c0f061a871dba40e5213) Signed-off-by: Jon Mason <jdmason@kudzu.us> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: make DISTRO_FEATURES description more explicitaatir2022-06-271-1/+3
| | | | | | | | | | | | | | Make DISTRO_FEATURES description more explicit by specifying that DISTRO_FEATURES alone can't select build configurations, and need mechanisms like PACKAGECONFIG setup to take care of selecting build configurations. Signed-off-by Aatir Manzur <aatrapps@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> (From yocto-docs rev: 4b39a4434ee658512050c50f6ebd5ad5dc900fb1) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: correct description of empty-root-passwd in IMAGE_FEATURESMichael Opdenacker2022-06-211-2/+13
| | | | | | | | | | "empty-root-passwd" doesn't actually set an empty root password. It just doesn't touch the initial root password which is empty by default. (From yocto-docs rev: 793cfe841148ead7e22fc2caf045247ab27a15da) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: IMAGE_FEATURES: add allow-root-login and correct ↵Michael Opdenacker2022-06-211-6/+8
| | | | | | | | | | | | | | allow-empty-password Completing the descriptions of "debug-tweaks". Correcting the description of "allow-empty-password" which doesn't imply accepting root logins. (From yocto-docs rev: 907c94886fd8a485a6045d71478e41a3c598821c) 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>
* ref-manual: document overlayfs-etc image featureVyacheslav Yurkov2022-01-071-0/+4
| | | | | | | | (From yocto-docs rev: 62c7cea1b916c04bfd5c25e0011424b90d5272a1) 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>
* docs: replace ``FOO`` by :term:`FOO` where possibleQuentin Schulz2021-06-191-11/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* 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: code insertion simplification over two linesMichael Opdenacker2021-04-231-2/+1
| | | | | | | | | | | | | | | 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: remove 'ref' from filenamesNicolas Dechesne2020-12-091-0/+350
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>