summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/variables.rst
Commit message (Collapse)AuthorAgeFilesLines
...
* ref-manual: remove newline string in PREMIRRORSMichael Opdenacker2021-12-131-4/+4
| | | | | | | | | | According to the syntax simplification brought by https://git.openembedded.org/bitbake/commit/?id=044fb04d (From yocto-docs rev: 19090efa1268fcb1fcfd3a2dc637d10d8a50dfad) Signed-off-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-25/+23
| | | | | | | (From yocto-docs rev: f4610b060968c481c68d0411b82201c302050b71) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: simplify SRC_URI referenceMichael Opdenacker2021-11-211-116/+9
| | | | | | | | | | After some features that also apply to BitBake were moved to the BitBake manual. (From yocto-docs rev: 1415521656427f351ab2d3f8bc498130c4653396) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: BBFILES_DYNAMIC - fix punctuation and quoting issuesMichael Opdenacker2021-11-211-2/+4
| | | | | | | (From yocto-docs rev: a798e1172ac507549ad36c0cfd4b92f53a1bef87) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: remove reference to TOPDIRMichael Opdenacker2021-11-211-5/+0
| | | | | | | | | | Already described in BitBake's manual As it is not specific to OE / Yocto Project (From yocto-docs rev: 150d5e938e9f413ade8bd6211ee7d55a2819a431) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: correct "take affect" by "take effect"Michael Opdenacker2021-11-071-3/+3
| | | | | | | (From yocto-docs rev: aeaf46f78b940744ce2e160e78b244395087e8e7) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: improve documentation for SDKMACHINERoss Burton2021-11-071-11/+9
| | | | | | | | | (From yocto-docs rev: 69bfb07772e7d358bb532191189a2518d1046178) Signed-off-by: Ross Burton <ross.burton@arm.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: fix description of SOURCE_DATE_EPOCHMichael Opdenacker2021-10-221-1/+1
| | | | | | | | | | Update the reference to the code that computes this default value for this variable. (From yocto-docs rev: b115a1c07f76d2cca37565ac678c21e0e6056fff) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: document SOURCE_DATE_EPOCHMichael Opdenacker2021-10-201-0/+17
| | | | | | | (From yocto-docs rev: 160d672641c52338ba499edfb66339a10b088490) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: document TOOLCHAIN_HOST_TASK_ESDKMichael Opdenacker2021-10-201-0/+9
| | | | | | | (From yocto-docs rev: 2adac164a2d4cf23c0372c1154709f2866d483fa) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: use YOCTO_DL_URLJon Mason2021-10-081-4/+4
| | | | | | | | (From yocto-docs rev: e3ad609d9fce8d6729bf6cb553993bddba1785ae) Signed-off-by: Jon Mason <jdmason@kudzu.us> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: replace http with https for URLsJon Mason2021-10-081-4/+4
| | | | | | | | | | | | https has been the preferred way to access websites for many years now. Change all of the URLs with a _working_ https server/certificate to use that URL. (From yocto-docs rev: c77868c780df94356d5f21453f80ace073fade9b) Signed-off-by: Jon Mason <jdmason@kudzu.us> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: update sources mirror URLJon Mason2021-10-081-4/+4
| | | | | | | | | | | The URL for the sources mirror no longer works. Update to the new location. (From yocto-docs rev: 616c326437c03d7f4530168c4c9d6ef50743952e) Signed-off-by: Jon Mason <jdmason@kudzu.us> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: document DEBUG_PREFIX_MAPMichael Opdenacker2021-10-081-0/+17
| | | | | | | | | Fixes [YOCTO #14433] (From yocto-docs rev: 23eb07c26044d06bc51c757bf1b0a53b1b357dc8) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: font fixesMichael Opdenacker2021-10-081-3/+3
| | | | | | | | | | | | | | 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 note about license implications of bundled initramfsDaniel Wagenknecht2021-10-021-0/+6
| | | | | | | | | | | Ensure users are aware that usage of INITRAMFS_IMAGE_BUNDLE is only appropriate for use with GPLv2 compatible software. (From yocto-docs rev: ecf4582b454aa301905f0f9e3c6f5adb98dc1991) 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: mention INHIBIT_PACKAGE_DEBUG_SPLIT variableRobert P. J. Day2021-10-021-0/+5
| | | | | | | | | | | Following a detailed discussion of PACKAGE_DEBUG_SPLIT_STYLE, it seems only appropriate to refer the reader to INHIBIT_PACKAGE_DEBUG_SPLIT. (From yocto-docs rev: d12a6149ed9ec4a5f7c47f4a8c0330c6024c9de5) 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: extend explanation of PACKAGE_DEBUG_SPLIT_STYLERobert P. J. Day2021-10-021-27/+33
| | | | | | | | | | | | The current explanation of this variable seems incomplete, so be a bit more verbose to make sure the reader understands the packaging possibilities. (From yocto-docs rev: 1914705f062b232c10624c11fc85935cc454d2eb) 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: improve documentation for RECIPE_NO_UPDATE_REASONMichael Opdenacker2021-09-181-0/+7
| | | | | | | | | | | This add a description of this variable to the variable index, and clarifies the explanations given in the devtool reference section. (From yocto-docs rev: 034b976addd0db6da31c4bacdbea21f2d47c00dc) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: remove checkpkg taskMichael Opdenacker2021-09-181-2/+2
| | | | | | | | | | | It doesn't exist any more and its functionality is now taken care of by "devtool check-upgrade-status" (From yocto-docs rev: 9c155e91dc57cb49b97805805e802330188a2c04) 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 UPSTREAM_CHECK_COMMITS and UPSTREAM_VERSION_UNKNOWNMichael Opdenacker2021-09-181-0/+24
| | | | | | | (From yocto-docs rev: 99b5fee6295a5c424fdb2cc0b34a4a486d7bf721) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* 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>
* 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>
* Manuals: replace "file name" by "filename"Michael Opdenacker2021-08-141-1/+1
| | | | | | | | | | | | 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-141-26/+26
| | | | | | | | | | 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-67/+67
| | | | | | | | | 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-1/+12
| | | | | | | | | | | | | 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>
* 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-301-6/+6
| | | | | | | | | | | | | 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-161-30/+30
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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-2/+2
| | | | | | | | | | | | | | | 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-592/+592
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* 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>
* 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-021-0/+3
| | | | | | | | | (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-221-39/+37
| | | | | | | (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>
* 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>
* 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-231-566/+283
| | | | | | | | | | | | | | | 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>