summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
* docs: replace ``FOO`` by :term:`FOO` where possibleQuentin Schulz2021-06-1938-1087/+1087
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* sdk-manual: fix broken referencesMichael Opdenacker2021-06-193-18/+16
| | | | | | | | | | | Detected by running: git grep "^[\ ]*\" section" | grep -v "\`" (From yocto-docs rev: 1e4909304a7e04fa707633b58c5e0d68a67d353a) 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>
* README: Tweak as the website isn't really new nowRichard Purdie2021-06-161-2/+2
| | | | | | (From yocto-docs rev: 78c50ffffb6f4dd38b5097a64c2e284a6177750a) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* releases: put release number after "Release Series"Michael Opdenacker2021-06-141-27/+27
| | | | | | | | | | | | This avoids a confusion because of the way other manuals are numbered, and aligns with the way the migration guides are listed. (From yocto-docs rev: 92f17a0ac68a64c86fa46ffbcec7acb3de3b23bf) 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>
* releases: clarify supported and outdated releasesMichael Opdenacker2021-06-141-4/+4
| | | | | | | | (From yocto-docs rev: c3d6c36497f7af1ca19357c5474ff1e5743f597b) 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: 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>
* test-manual: Add initial YP Compatible documentationRichard Purdie2021-06-142-0/+125
| | | | | | | | | | | | | This starts documenting the Yocto Project Compatible badging programme. This adds an initial piece of documentation about it from which we can improve as needed. (From yocto-docs rev: baa70e3d0d6100e091eb78cf465a9734068a44e7) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> Signed-off-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: migration-2.2: add note about IMGDEPLOYDIRDaniel Wagenknecht2021-06-141-0/+11
| | | | | | | | | (From yocto-docs rev: e9921b746a0b2a4a2192bab224d9afa9d9395e1e) 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: 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-1423-67/+71
| | | | | | | | | | | | | | 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>
* manuals: fix epub export warningsMichael Opdenacker2021-06-141-0/+3
| | | | | | | | | Needed now that warnings are turned into errors (From yocto-docs rev: 3f99cff8c6c672967eb09f6950d16ed30260ca68) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Makefile: turn warnings into errors by defaultQuentin Schulz2021-06-141-1/+1
| | | | | | | | | | | | | -W is for turning warnings into errors, --keep-going to make sure the whole documentation is built and all warnings will be printed before failing. Since there's currently no warning, it's time to introduce it! (From yocto-docs rev: 5d7b8547549b2203a03df617cdba70ccf2194c62) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* test-manual: add initial reproducible builds documentationRichard Purdie2021-06-142-0/+136
| | | | | | | | | (From yocto-docs rev: a4ec469042ccb2487c1d076a2c005f33f8021816) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> 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>
* 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>
* index: split releases manuals and indexes into two sections in the treeNicolas Dechesne2021-06-021-4/+7
| | | | | | | | | (From yocto-docs rev: f245b7b096f699cdc4426022d61d963d7deb9a92) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Reviewed-by: Quentin Schulz <foss@0leil.net> Tested-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* index: remove links to releases manual and indexNicolas Dechesne2021-06-021-0/+1
| | | | | | | | | | | | Keep the links in the left side navigation bar, but remove them from the main page. (From yocto-docs rev: d01324cfb6ecada22005ca05db99b0c1f75eb22e) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Reviewed-by: Quentin Schulz <foss@0leil.net> Tested-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* index: remove the link/section to 'mega manual' from main pageNicolas Dechesne2021-06-021-6/+0
| | | | | | | | | | | | | The 'megamanuel' can be selected using the drop down menu on the documentation website. It was reported it is confusing to have it on the main page (and in the left side bar) as well. Let's remove it. (From yocto-docs rev: 593898dc4a4695395856ea481b58cc5092ed3263) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Reviewed-by: Quentin Schulz <foss@0leil.net> Tested-by: Michael Opdenacker <michael.opdenacker@bootlin.com> 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>
* releases: update to include 3.1.8Michael Halstead2021-06-022-1/+2
| | | | | | | | | Adding 3.1.8 to documentation switcher and release list. (From yocto-docs rev: 657408bf30279b44f1e1255787a2c56b739df142) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* releases: update to include 3.3.1Michael Halstead2021-05-253-5/+6
| | | | | | | | | Adding 3.3.1 to documentation switcher and release list. (From yocto-docs rev: db80bb70d9bea7008cb6b2795c8f617b1486ca03) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> 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>
* manuals: simplify styleMichael Opdenacker2021-05-224-28/+26
| | | | | | | (From yocto-docs rev: 3332ee547cde0f2f8718f83d526b21339b0a8901) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: simplify style and add missings referencesMichael Opdenacker2021-05-223-53/+46
| | | | | | | (From yocto-docs rev: 4a07947dbe0dd70fd1d528a207d663dfdca2b7c1) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: simplify style and fix formatingMichael Opdenacker2021-05-223-27/+27
| | | | | | | (From yocto-docs rev: fffd2ce4c9efbdeb75b7afd6f4f2ce4ffca517ad) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: simplify styleMichael Opdenacker2021-05-223-90/+79
| | | | | | | (From yocto-docs rev: a8b3c1a5cbfa7fb0bca0d7dd8f38ac59acf032fa) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev manual: simplify styleMichael Opdenacker2021-05-225-18/+18
| | | | | | | (From yocto-docs rev: 5bbbed35175ffcabb24bcac305d17563b8d9b9e3) Signed-off-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>
* poky.yaml: fedora33: add missing pkgsArmin Kuster2021-05-221-1/+2
| | | | | | | | | | | | | | | | | | | | | [ Yocto #14188] The following packages where needed to a fresh FC33 install perl-FindBin perl-File-Compare perl-File-Copy perl-locale Error seen: openssl-native-1.1.1g-r0 do_configure: Execution of '/{snipped}/build/tmp-glibc/work/x86_64-linux/openssl-native/1.1.1g-r0/temp/run.do_configure.14627' failed with exit code 2: Can't locate FindBin.pm in @INC (you may need to install the FindBin module) (From yocto-docs rev: 5b4127dd72a465ff8c962c425e78140ca8e536db) Signed-off-by: Armin Kuster <akuster808@gmail.com> Reviewed-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>
* releases: update to include 3.2.4Michael Halstead2021-05-183-2/+3
| | | | | | | | | Adding 3.2.4 to documentation switcher and release list. (From yocto-docs rev: b24cddff0f1367360441e3f9ff59cbed77da28ad) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: reduce verbosity related to "the following" expressionMichael Opdenacker2021-05-1313-41/+36
| | | | | | | (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-135-10/+9
| | | | | | | | (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-132-0/+47
| | | | | | | | | (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-132-4/+4
| | | | | | | | (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>
* sdk-manual: various cleanups to intro.rstRobert P. J. Day2021-05-131-25/+23
| | | | | | | | | | | | Minutiae including grammar fixes, increased brevity and adding a proper link to another SDK manual section. (From yocto-docs rev: 21d6c6fcbae938c256da6e72d6ac8d2ca72d5bc0) 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>
* sdk-manual: couple minor fixes in using.rstRobert P. J. Day2021-05-131-7/+6
| | | | | | | | | | One grammar fix, and adding two proper links to other sections. (From yocto-docs rev: 969d4737da992e1fbca14cfbeb35bd5401698cba) 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>
* sdk-manual: fix broken formatting of sample commandRobert P. J. Day2021-05-031-3/+5
| | | | | | | | | | | | | And add proper quoting around the first instance of the "image" word, as it refers to a keyword in the subsequent command. (From yocto-docs rev: 1ffaa1db5a6eba53558b714f6071ea2e9bfe03e6) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: update references to Docker installation instructionsMichael Opdenacker2021-05-031-18/+10
| | | | | | | | | | | | | | | Update Docker installation URL on various plaforms, replacing some URLs by the ones they now redirect to, renaming "Docker CE" to "Docker Desktop" on Mac and Windows, and to "Docker Engine" on GNU/Linux. Stop mentioning "Docker Toolbox" which is now deprecated and replaced by "Docker Desktop" on Mac and Windows. (From yocto-docs rev: 8eb249aed50b7b5b2078648c9efd9c79262ae57f) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: "beablebone" -> "beaglebone"Robert P. J. Day2021-05-031-1/+1
| | | | | | | | (From yocto-docs rev: 29d8b6f07dddba43cf14706ec26cc8cf033d1040) 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>
* dev-manual/common-tasks.rst: correct the documentation for debuginfodAlexander Kanavin2021-05-032-22/+24
| | | | | | | | | | | | | | 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-2338-1949/+974
| | | | | | | | | | | | | | | 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>