summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
Commit message (Collapse)AuthorAgeFilesLines
* ref-manual: update SYSROOT_DIRS_* variable entriesRobert P. J. Day2021-09-041-1/+8
| | | | | | | | | | | Both SYSROOT_DIRS and SYSROOT_DIRS_BLACKLIST have more current values. (From yocto-docs rev: 750ae3fca42e273cd533f9c8b678c2e144164191) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Reviewed-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add missing "${PN}-src" to default PACKAGES listRobert P. J. Day2021-09-041-1/+1
| | | | | | | | | (From yocto-docs rev: c4e986364fc67799a9cba8fa1e9d33481bebaa8c) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Reviewed-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: Fix reference to bbappend section of dev-manualRichard Purdie2021-08-201-2/+2
| | | | | | (From yocto-docs rev: 015914cdbe3f58a39ec64ee6a4181d3d29741205) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: update docs with new tune locationsJon Mason2021-08-181-1/+1
| | | | | | | (From yocto-docs rev: ce6d3dbaea9d6250567d23e7d95ce9cbd3a03c99) Signed-off-by: Jon Mason <jdmason@kudzu.us> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kickstart: document which options accept unitsOlaf Mandel2021-08-141-10/+20
| | | | | | | | | | | | | Document which units are accepted as parameters for the four options that accept units. Also be pedantic about using binary instead of decimal prefixes so readers don't have to wonder. (From yocto-docs rev: 6b1d7d102ed3b509dfb3e43a3d7a27226f504df5) Signed-off-by: Olaf Mandel <o.mandel@menlosystems.com> Reviewed-by: Quentin Schulz <foss@0leil.net> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Manuals: replace "file name" by "filename"Michael Opdenacker2021-08-142-2/+2
| | | | | | | | | | | | There are many more instances of "filename" or "filenames" than of "file name" or "file names". The winner takes it all! (From yocto-docs rev: 13ef92bc301166c2e21d2603b2501749248dbe91) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: fix new override syntax migrationQuentin Schulz2021-08-143-38/+38
| | | | | | | | | | 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-144-78/+78
| | | | | | | | | 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-102-1/+28
| | | | | | | | | | | | | 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>
* ref-manual: remove example recipe source filesMichael Opdenacker2021-08-025-63/+0
| | | | | | | | | | | | | These files are not used to build to documentation and were updated and moved to the "meta-skeleton" layer (except "mtd-makefile" which is broken and no longer worth maintaining there, as a recipe for more recent versions of "mtd-utils" exists). (From yocto-docs rev: 5fc765fc22e2fa3124089f609db2e60113606c81) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: initial documentation for CVE managementMichael Opdenacker2021-08-021-0/+12
| | | | | | | | | | | This starts to document vulnerability management and the use of the CVE_PRODUCT variable (From yocto-docs rev: 2b9199fe490cb3ec126bffc6518646194a94ace4) 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: remove explicit BitBake variable referencesMichael Opdenacker2021-07-301-3/+2
| | | | | | | | | | | | | The standard :term:`VARIABLE` will refer to the description of the variable in the YP variable index. If it doesn't exist, it will refer to the description of the variable in the BitBake manual. (From yocto-docs rev: 34cb466caf872f9284eb81f6a5f31ad606214dee) 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: simplify references to BitBake manualMichael Opdenacker2021-07-302-8/+8
| | | | | | | | | | | | | Replacing ":ref:`section name<bitbake:bitbake-user-manual/bitbake-user-manual-<section>:section name>`" by ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-<section>:section name`" when the reference description is the same as the section name. In this case, that's unnecessary to repeat the section name in the description part. (From yocto-docs rev: 6a1a590f9ef77dc8842ea5945661135992eb94e1) 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>
* ref-manual: Document BUILDHISTORY_PATH_PREFIX_STRIPJoshua Watt2021-07-161-0/+14
| | | | | | | | (From yocto-docs rev: c834fab46794233864e6bcb587ab75f2bfa1631c) Signed-off-by: Joshua Watt <JPEWhacker@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: replace remaining ``FOO`` by :term:`FOO`Quentin Schulz2021-07-165-38/+38
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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-102-17/+3
| | | | | | | | | | | | | | | 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>
* manuals: fix issues related to trailing dotsMichael Opdenacker2021-06-191-3/+2
| | | | | | | | | | | | | Fix missing reference and styling issues found thanks to trailing dots (only non black character in a line) Matches (and multiple false positives) found with the below command: git grep "\s\.$" (From yocto-docs rev: 1d3026f50753d9ccf39b7d0163c77c765d754994) Signed-off-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-198-678/+678
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* ref-manual: variables: fixup class reference in IMAGE_MANIFESTDaniel Wagenknecht2021-06-141-1/+1
| | | | | | | | | | | The definition of IMAGE_MANIFEST was moved to a different class. Fixup the documentation to reflect this change. (From yocto-docs rev: 15c0a09154de2a1f6d36e1bb5bf283bd08c9ec3d) Signed-off-by: Daniel Wagenknecht <dwagenknecht@emlix.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: variables: fixup example in IMAGE_CMDDaniel Wagenknecht2021-06-141-2/+2
| | | | | | | | | | | | The example for IMAGE_CMD_jffs2 given in the glossary for IMAGE_CMD didn't align with the implementation anymore. Update it to match the implementation. (From yocto-docs rev: 4db4efc42af89a109313c4cf33ae13e8236215e9) Signed-off-by: Daniel Wagenknecht <dwagenknecht@emlix.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: variables: document IMGDEPLOYDIRDaniel Wagenknecht2021-06-141-0/+19
| | | | | | | | | | | | | DEPLOY_DIR_IMAGE has been replaced by IMGDEPLOYDIR for most use cases since OE-Core rev 6d969bacc718e21a5246d4da9bf9639dcae29b02. Document IMGDEPLOYDIR and add a note to DEPLOY_DIR_IMAGE about it. (From yocto-docs rev: dad7046f9428bde476d2241209c118d52529bed5) Signed-off-by: Daniel Wagenknecht <dwagenknecht@emlix.com> 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>
* ref-manual: variables: update examples refering to DEPLOY_DIR_IMAGEDaniel Wagenknecht2021-06-141-3/+3
| | | | | | | | | | | | | | DEPLOY_DIR_IMAGE has been replaced by IMGDEPLOYDIR for most use cases since OE-Core rev 6d969bacc718e21a5246d4da9bf9639dcae29b02. Update examples given in the documentation to use IMGDEPLOYDIR and match their implementation. (From yocto-docs rev: 6cad5984306ffbf748a888cedc1a5015105e89fa) Signed-off-by: Daniel Wagenknecht <dwagenknecht@emlix.com> 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>
* ref-manual: move migration guides to separate documentMichael Opdenacker2021-06-1422-5704/+4
| | | | | | | | | | | | | | This makes the reference manual much lighter by moving the migration guides to a separate document. The migration guides are also reordered from last to first, and they appear directly in the left bar, making them easier to find in the documentation. (From yocto-docs rev: 5121b86ee97eb62a0c69c9ad1fc0e3fabbe3e934) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Remove Clutter referencesRoss Burton2021-06-052-19/+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>
* docs: ref-manual: variables: add missing links to terms glossaryQuentin Schulz2021-06-051-2/+2
| | | | | | | | | | | | | | The automated script used back then didn't take into account that terms could be lowercase which is the case for module_autoload and module_conf, so let's add a link to those too. Fixes: 9e468274eaad "docs: ref-manual: ref-variables: add links to terms in glossary" (From yocto-docs rev: beeaf0c48dcd79626c1591a68da4b13387aa0c3f) 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: ref-manual: migration-3.0: remove reference to non-existing ↵Quentin Schulz2021-06-051-4/+3
| | | | | | | | | | | | | | | | | | | BB_SETSCENE_VERIFY_FUNCTION2 This variable has been removed in July 2019 with commit 5deaa5df730a "runqueue: Drop unused BB_SETSCENE_VERIFY_FUNCTION2" in bitbake git repo. The glossary entry for the variable has been recently removed from bitbake documentation, therefore the ref breaks the build. Let's remove the reference so that the build still passes. (From yocto-docs rev: 4db673a559d290547d4d6006ea692becb574deb7) 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: add glossary entry for NON_MULTILIB_RECIPESRobert P. J. Day2021-06-021-0/+7
| | | | | | | | | (From yocto-docs rev: 6ed8e747265df899d8ce464d83281b0e0f04f9b2) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Document erofs filesystem targetsRichard Weinberger2021-06-022-3/+8
| | | | | | | | | (From yocto-docs rev: 94cbbec788660cc3b18232e2343ce6723942426c) Signed-off-by: Richard Weinberger <richard@nod.at> Reviewed-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: add SRCTREECOVEREDTASKS to variable glossaryRobert P. J. Day2021-06-021-0/+24
| | | | | | | | (From yocto-docs rev: c3e8eb234c9d1cf67dc46666ea26c1e4eb945c2c) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Reviewed-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add links to some variables in glossaryRobert P. J. Day2021-05-221-6/+6
| | | | | | | | | | | Add some links to a small set of glossary variables that I happened to be perusing at the time. (From yocto-docs rev: d71d8da78285f2314bfd27a821b26434e39622a8) 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>
* ref-manual: simplify styleMichael Opdenacker2021-05-2211-76/+69
| | | | | | | (From yocto-docs rev: 657a7f54856afd6fec7f2cb0b5f12b4b2d24adb7) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Ubuntu 20.04 is also LTSRoss Burton2021-05-221-1/+1
| | | | | | | | (From yocto-docs rev: e7b7ec18c27b34e96de9b576b8bfe518f7466bff) 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: reduce verbosity related to "the following" expressionMichael Opdenacker2021-05-134-8/+8
| | | | | | | (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-132-3/+3
| | | | | | | | (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>
* kernel-dev: document KCONFIG_MODEDaniel Wagenknecht2021-05-131-0/+38
| | | | | | | | | (From yocto-docs rev: 12aa6f9c6af68ea03fbb056677213b00d693cf5f) Signed-off-by: Daniel Wagenknecht <dwagenknecht@emlix.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: delete extraneous back quoteRobert P. J. Day2021-05-131-1/+1
| | | | | | | | (From yocto-docs rev: 784d39fe28436302b4df7e1ea08582d4d2f664c6) 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>
* ref-manual: delete references to dead LSB complianceRobert P. J. Day2021-05-131-9/+1
| | | | | | | | | | | Since LSB does not seem to be relevant these days, delete mentions of it. (From yocto-docs rev: 5b4354e0611253b40ad58613b910b6591493a1b4) 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>
* manuals: fix a few incorrect option specifications.Drew Moseley2021-05-131-1/+1
| | | | | | | | (From yocto-docs rev: b6b218de3629d1f8fb61137e8bdcf84739cfaf67) Signed-off-by: Drew Moseley <drew@moseleynet.net> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual/common-tasks.rst: correct the documentation for debuginfodAlexander Kanavin2021-05-031-6/+0
| | | | | | | | | | | | | | Particularly, - correctly describe the use of DEBUGINFOD_URLS; drop it from bitbake variables - all necessary component tweaks are enabled by default via DISTRO_FEATURES - provide on-target examples of what to look for when things work properly (From yocto-docs rev: 6d5d568d427b22675b999f94ead829ab1bef0b21) Signed-off-by: Alexander Kanavin <alex.kanavin@gmail.com> Reviewed-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/variables.rst: Add incompatibility warning for SERIAL_CONSOLES_CHECKTrevor Gamblin2021-04-231-1/+5
| | | | | | | | | | | | | | See [YOCTO #13921] Add details to the SERIAL_CONSOLES_CHECK entry to clarify that it doesn't work with read-only rootfs. (From yocto-docs rev: cefd66301a40f9048499879674e467543f704c44) Signed-off-by: Trevor Gamblin <trevor.gamblin@windriver.com> Reviewed-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-2323-833/+416
| | | | | | | | | | | | | | | 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>
* manuals: simplify code insertionMichael Opdenacker2021-04-2311-29/+29
| | | | | | | | | | This replaces instances of ": ::" by "::", which generates identical HTML output (From yocto-docs rev: 1f410dfc7c16c09af612de659f8574ef6cff4636) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add mention of DISTUTILS_SETUP_PATHPaul Eggleton2021-04-152-0/+42
| | | | | | | | | | Add a variable glossary entry and corresponding 3.3 migration section entry for DISTUTILS_SETUP_PATH. (From yocto-docs rev: 0823237e6f4b9dbdf48500b3c1e8cc61696fa2d2) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: migration guide: add release codenamesPaul Eggleton2021-04-1518-54/+54
| | | | | | | | | | | People will see release codenames in other contexts, and thus it is useful to mention them explicitly here rather than having to go to the Releases wiki page to map version number to release codename. (From yocto-docs rev: fe3a91e8b3ef09b79711b62c6a08643f9444dcec) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add migration section for 3.3 releasePaul Eggleton2021-04-152-0/+140
| | | | | | | (From yocto-docs rev: b8b6e8335be382337fe4adda11d5a90872ff4c79) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: tweak buildtools sectionPaul Eggleton2021-04-151-2/+6
| | | | | | | | | | Add a joining paragraph and fix the second section so that it makes sense with the addition of the first one. (From yocto-docs rev: 8ee993995d9d72873f36e40dda5e3f345901978c) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: fix reference to build-essentialPaul Eggleton2021-04-151-1/+2
| | | | | | | | | This has been here since the text was added to the DocBook version. (From yocto-docs rev: 611588b065ab98d7021173525027d16b5ab519c8) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add FIT_KERNEL_COMP_ALG*Paul Eggleton2021-04-151-0/+10
| | | | | | | | | | | | Add FIT_KERNEL_COMP_ALG and FIT_KERNEL_COMP_ALG_EXTENSION. Examining OE-Core commit 5c72105e2973e613b5c0f0e6310ffdea6e56c6c7 and the associated code, these do not enable arbitrary selection of compression algorithm - only disabling compression - so document them accordingly. (From yocto-docs rev: 41640526dd87153fdf802b058336c6fb466b8ade) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add passwd-expire to EXTRA_USERS_PARAMSPaul Eggleton2021-04-151-0/+11
| | | | | | | | | | Add a reference to the recently added passwd-expire command in EXTRA_USERS_PARAMS. (From yocto-docs rev: 9a6c8b37a1e6baab4dfb2ffe7b4abdf7dcbb8822) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add python3targetconfig class and remove python 2 referencesPaul Eggleton2021-04-153-59/+20
| | | | | | | | | | 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>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-11-14 15:22:08 +0000