summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
* 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: Rename the "Using .bbappend Files in Your Layer" sectionTom Rini2021-08-144-7/+10
| | | | | | | | | | | | | | To prepare to add another example bbappend, rename the current "Using .bbappend Files in Your Layer" section to "Appending Other Layers Metadata With Your Layer". Name the current example as "Overlaying a File Using Your Layer". (From yocto-docs rev: 62d7b5721b2fbcf1e22fc4e7bbac51d52260730e) Signed-off-by: Tom Rini <trini@konsulko.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>
* common-tasks: Add a summary to the end of the bbappend exampleTom Rini2021-08-141-0/+6
| | | | | | | | | | | | Try and make it clearer what the final result of this bbappend example is. (From yocto-docs rev: c6d0b030fe495a9eb81ad542ad56479f7e7e18e2) Signed-off-by: Tom Rini <trini@konsulko.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>
* docs: fix typo in releasesDaniel Gomez2021-08-141-2/+2
| | | | | | | | | | Fix dunfell typo for releases 3.1.9 and 3.1.10. (From yocto-docs rev: aae1f5c1a4a0e1d56cfea66d06dbf8edbc084b8d) Signed-off-by: Daniel Gomez <daniel@qtec.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: fix grammar in post-install script explanationsMichael Opdenacker2021-08-141-3/+3
| | | | | | | (From yocto-docs rev: bc0fa4d432c3a9aeccc5758c7ca793cae4f4852b) Signed-off-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-144-7/+7
| | | | | | | | | | | | 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>
* sdk-manual: reference obsolete reference to ADTMichael Opdenacker2021-08-141-10/+0
| | | | | | | (From yocto-docs rev: 024258ecd3c50184ab38d54e7bec2698c04fc631) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: overview-manual: concepts: remove long-gone BBHASHDEPS variableQuentin Schulz2021-08-141-3/+0
| | | | | | | | | | | | | | BBHASHDEPS was removed from bitbake in April 2014, with the following commit: 92526eadd09d "bitbake-worker: Drop BBHASH variables" so let's remove mentions from the docs. (From yocto-docs rev: f9e1768b8c85e3ad7fa974940a90996a5ffee3f5) 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: fix new override syntax migrationQuentin Schulz2021-08-1412-93/+93
| | | | | | | | | | 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>
* test-manual: overrides syntax updatesMichael Opdenacker2021-08-141-1/+1
| | | | | | | | | Updated with openembedded-core/scripts/contrib/convert-overrides.py (From yocto-docs rev: 4bb16d0d1a0b8a42f20f39d79c642d612074565a) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: overrides syntax updatesMichael Opdenacker2021-08-143-3/+3
| | | | | | | | | Updated with openembedded-core/scripts/contrib/convert-overrides.py (From yocto-docs rev: 39cf6b2eb063815a3e2bf7a71ffd1fd6351cc594) Signed-off-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>
* kernel-dev manual: overrides syntax updatesMichael Opdenacker2021-08-142-33/+33
| | | | | | | | | Updated with openembedded-core/scripts/contrib/convert-overrides.py (From yocto-docs rev: d4598b592d1b0c9ce9448a8858eb4f47d83487b2) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: overrides syntax updatesMichael Opdenacker2021-08-141-98/+98
| | | | | | | | | Updated with openembedded-core/scripts/contrib/convert-overrides.py (From yocto-docs rev: 105c4af0f2d78f27639f4f4d8ee4be65fcbfda52) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide: overrides syntax updatesMichael Opdenacker2021-08-141-26/+26
| | | | | | | | | Updated with openembedded-core/scripts/contrib/convert-overrides.py (From yocto-docs rev: 664890810e8dcdaf3dd4467ef8f9a99f72ce6dce) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* releases: update to include 3.1.10Michael Halstead2021-08-112-1/+2
| | | | | | | | | Adding 3.1.10 to documentation switcher and release list. (From yocto-docs rev: 86b44b72c366f56d6977e7462aca8821721d89bd) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: further documentation for cve-checkMichael Opdenacker2021-08-103-1/+97
| | | | | | | | | | | | | 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: mention license information in footerMichael Opdenacker2021-08-101-1/+1
| | | | | | | | | | Previously, the license for the manuals was only stated in the SPDX headers at the beginning of source files (From yocto-docs rev: cef60f23d5601a18d7ba7e894af2aa459fb2efb8) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-3.4: Add extra notes to override syntax changesRichard Purdie2021-08-101-0/+7
| | | | | | | | (From yocto-docs rev: dba53562b684c511fb59a3272656cb6052f28fb2) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* test-manual: Add extra detail to YP Compatible sectionRichard Purdie2021-08-101-0/+5
| | | | | | | | | | | Add a note about documenting where a layer doesn't support 'core' functionality. (From yocto-docs rev: 0fc15d069aae11e6e705d80f684345150ff7bf3b) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* releases: update to include 3.3.1Michael Halstead2021-08-043-5/+6
| | | | | | | | | Adding 3.3.1 to documentation switcher and release list. (From yocto-docs rev: 3c98afb0fefd889e8036639d9a2c775b73b237c2) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* profile-manual: document how to build perf manpages on targetMichael Opdenacker2021-08-021-5/+6
| | | | | | | | | | Thanks to closing yocto bug #3388, there is now a simple way to build the perf manpages for use on the target (From yocto-docs rev: 12dd3ecb054c1668cdccc220ca21b88635531784) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> 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-022-0/+57
| | | | | | | | | | | 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>
* dev-manual: fix source release example scriptStefan Wiehler2021-08-021-1/+1
| | | | | | | | (From yocto-docs rev: 6c939a3bbc9116d32c73df58f60ceb4809328eb3) Signed-off-by: Stefan Wiehler <stefan.wiehler@missinglinkelectronics.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* common-tasks: Fix conversion error in npm exampleRichard Purdie2021-07-301-1/+2
| | | | | | (From yocto-docs rev: a6441aa5765be4a121a45ede94ca6d4c6fedf4ef) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: remove explicit BitBake variable referencesMichael Opdenacker2021-07-304-11/+8
| | | | | | | | | | | | | 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-307-17/+18
| | | | | | | | | | | | | 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>
* documentation/README: improve BitBake manual referencing guidelinesMichael Opdenacker2021-07-301-3/+12
| | | | | | | | | | | | Removing the ":ref:`-D <bitbake:..." syntax as it's not necessary Adding more and simpler ways of making references to the BitBake manual. (From yocto-docs rev: 7ad087a81e5dca7088c8088cd0cdcf31606baa6e) 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>
* migration-guides: Add start of 3.4 guide with override migration notesRichard Purdie2021-07-302-0/+77
| | | | | | | | | (From yocto-docs rev: e60019c81e63250feaee4937873a90042074030b) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> Reviewed-by: Quentin Schulz <foss@0leil.net> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: fix wrong reference to classMichael Opdenacker2021-07-301-1/+1
| | | | | | | | | | | The file 'meta/classes/core-image.bbclass' seems have nothing about the 'IMAGE_FEATURES' variable, using 'meta/classes/image.bbclass' instead. (From yocto-docs rev: b0eb9ef09c73db97e3f289565d0ce17d9aa7e8cd) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Mingrui Ren <jiladahe1997@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* quick start manual: update "source oe-init-build-env" outputMichael Opdenacker2021-07-301-1/+8
| | | | | | | (From yocto-docs rev: 0c8be05b393ea318d033af6b596da5349c75653a) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* test-manual: document LTO related reproducibility bugMichael Opdenacker2021-07-301-0/+11
| | | | | | | | (From yocto-docs rev: 33b6f7cec780f77ed9cd0518f72ec8c0e3c08e68) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Tony Battersby <tonyb@cybernetics.com> 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-1619-74/+74
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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-103-18/+4
| | | | | | | | | | | | | | | 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>
* releases: update to include 3.1.9Michael Halstead2021-07-022-1/+2
| | | | | | | | | Adding 3.1.9 to documentation switcher and release list. (From yocto-docs rev: 6951b86a2e0e95bb72db12624efa23fec579bc70) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: add missing index referencesMichael Opdenacker2021-06-191-4/+2
| | | | | | | (From yocto-docs rev: 3308b9bebce69cda1b2e0bd69f59b304ea1e367f) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: fix wrong wordMichael Opdenacker2021-06-191-1/+1
| | | | | | | (From yocto-docs rev: 93c43a019e3f44b0eb83a16e44372d98b5dce1a9) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: add missing quoting around "devtool upgrade"Michael Opdenacker2021-06-191-1/+1
| | | | | | | (From yocto-docs rev: 8863967d1e4e4a5b8014bf55302752419352c25d) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: fix issues related to trailing dotsMichael Opdenacker2021-06-194-14/+6
| | | | | | | | | | | | | 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>
* migration guides: remove index reference to BB_SETSCENE_VERIFY_FUNCTION2Michael Opdenacker2021-06-192-3/+3
| | | | | | | | | | This variable is no longer documented in Bitbake's manual as it's not in use any more. (From yocto-docs rev: 68328d93023d2e3251a05ea2830c4f6b6de65708) 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-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>