summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
Commit message (Collapse)AuthorAgeFilesLines
* ref-manual: Clarify recommended operator for PROVIDESJoshua Watt2021-01-201-11/+4
| | | | | | | | | | Updates the documentation for PROVIDES so that it recommends "+=" instead of "=". (From yocto-docs rev: 39b2ca1e27592488d396d5f0d76965f0006515a1) Signed-off-by: Joshua Watt <JPEWhacker@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/ref-classes: update kernel-fitimage with Initramfs bundle and ↵Abdellatif El Khlifi2021-01-201-5/+27
| | | | | | | | | | | | | boot script This commit adds the description of the Initramfs bundle and boot script new features implemented in the kernel-fitimage class. Change-Id: Ifffa6b850308aa7ceadc4f117806cffad0137137 (From yocto-docs rev: a55c16555366c0adbf4a087b86574b07972cbc52) Signed-off-by: Abdellatif El Khlifi <abdellatif.elkhlifi@arm.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: fix missing & and ; surrounding references from poky.yamlQuentin Schulz2021-01-205-12/+12
| | | | | | | | | | | | poky.yaml references are only replaced in files if they are prefixed by & and suffixed by ;. Let's fix the missing surrounding characters. (From yocto-docs rev: 7ee4ba7a27acd87d8c728639d1b053d2e26c6e58) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* common-tasks.rst: Fix GNU_HASH in hello.bbLeon Anavi2021-01-151-1/+1
| | | | | | | | | | | | | Fix the following GNU_HASH issue in "Single .c File Package (Hello World!)" example: ERROR: hello-1.0-r0 do_package_qa: QA Issue: File /usr/bin/helloworld in package hello doesn't have GNU_HASH (didn't pass LDFLAGS?) [ldflags] Reported-by: Matthew Tsenkov <matthew.tsenkov@konsulko.com> (From yocto-docs rev: 99a53f443193c0becd48a07a2dd740bb417dcf49) Signed-off-by: Leon Anavi <leon.anavi@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Fix a Concpets -> Concepts typoYoann Congal2021-01-151-1/+1
| | | | | | | (From yocto-docs rev: 78bdf1c25c5c546c35b5a0d246aa1bbd70d5eace) Signed-off-by: Yoann Congal <yoann.congal@smile.fr> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* variables: Add documentation for KERNEL_DTC_FLAGSOvidiu Panait2021-01-051-0/+9
| | | | | | | | | Add documentation for the newly introduced KERNEL_DTC_FLAGS variable. (From yocto-docs rev: b2d5bf48fe4e76446a38762839865176294a4a3c) Signed-off-by: Ovidiu Panait <ovidiu.panait@windriver.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: terms: Fix poky tarball root folderElvis Stansvik2021-01-041-1/+2
| | | | | | | | | When extracting the tarball the root folder is not named `poky`, but e.g. `poky-gatesgarth-24.0.0`. (From yocto-docs rev: 8c92f709cbd96310b7153dd55dae8fa4899a7818) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Use https links where possiblePaul Barker2020-12-2410-25/+25
| | | | | | | (From yocto-docs rev: cd4c5e9928866f910ac97cf3e0612e6245da30bd) Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Simplify oe_lists linkPaul Barker2020-12-241-2/+2
| | | | | | | (From yocto-docs rev: 9521c5b5538295d3bfa6b9b07cbf67b62b78a0dc) Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Simplify layerindex and layer linksPaul Barker2020-12-241-1/+1
| | | | | | | (From yocto-docs rev: b157d57cc50b0a9cfaa062fa0e966b4d29eceeec) Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Simplify oe_wiki and oe_home linksPaul Barker2020-12-241-2/+1
| | | | | | | (From yocto-docs rev: 6867f54f349edede37c4085194f51342c24297ed) Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: use consistent capitalisation of U-BootPaul Eggleton2020-12-243-8/+8
| | | | | | | | | Change all instances of U-boot to U-Boot. (From yocto-docs rev: 153c60fd9f2807c8e98105bcd4384e52e2adaa1a) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* variables: Add documentation for new kernel-fitimage varsPaul Eggleton2020-12-241-0/+32
| | | | | | | | | | Add documentation for FIT_DESC, FIT_SIGN_INDIVIDUAL, UBOOT_MKIMAGE, UBOOT_MKIMAGE_SIGN and UBOOT_MKIMAGE_SIGN_ARGS. (From yocto-docs rev: 3c8c9d419d0137279ba1a4e7d3f381df93d6f12d) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* variables: explicitly state that UBOOT_MKIMAGE_DTCOPTS is optionalPaul Eggleton2020-12-241-0/+2
| | | | | | | (From yocto-docs rev: 0ba5591c4e8dd194f87837556cedb2b9979bc6df) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* variables: clarify KERNEL_ALT_IMAGETYPE referencePaul Eggleton2020-12-241-2/+3
| | | | | | | | | | Make it clear that KERNEL_ALT_IMAGETYPE is intended to allow building an additional image type. (From yocto-docs rev: d2f51d310028dfa50584f7dc04ea3627d14d3f1e) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* classes: minor corrections to kernel-fitimage sectionPaul Eggleton2020-12-241-5/+5
| | | | | | | | | Minor syntax and formatting corrections. (From yocto-docs rev: eda1fae0dc8670ff22f10b591ce14b9bbf0455ce) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: remove 'ref' from filenamesNicolas Dechesne2020-12-0920-39/+39
| | | | | | | | | | | All filenames duplicate the 'manual name', which is not needed, and make all references longer than they should. Rename all files to be as consise as possible, and fix all references (From yocto-docs rev: bb7e4783f45a5f67e6e4b39968f3512f43738833) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: remove 'sdk' from filenamesNicolas Dechesne2020-12-096-19/+19
| | | | | | | | | | | All filenames duplicate the 'manual name', which is not needed, and make all references longer than they should. Rename all files to be as consise as possible, and fix all references (From yocto-docs rev: bd8c0f7fc09a39a8bbde1c05b51693955738e148) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: remove 'overview-manual' from filenamesNicolas Dechesne2020-12-0910-58/+58
| | | | | | | | | | | All filenames duplicate the 'manual name', which is not needed, and make all references longer than they should. Rename all files to be as consise as possible, and fix all references (From yocto-docs rev: 4f489a40bb00be018e419802a76fec9dbee3f255) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: remove 'kernel-dev' from filenamesNicolas Dechesne2020-12-093-12/+12
| | | | | | | | | | | All filenames duplicate the 'manual name', which is not needed, and make all references longer than they should. Rename all files to be as consise as possible, and fix all references (From yocto-docs rev: 3d7eb2c5e1d230290c97dd8e5b528086e1d8034a) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: remove 'dev-manual' from filenamesNicolas Dechesne2020-12-0921-111/+111
| | | | | | | | | | | All filenames duplicate the 'manual name', which is not needed, and make all references longer than they should. Rename all files to be as consise as possible, and fix all references (From yocto-docs rev: 00a9244587e2e63f2a5197ed0dfc89cb330f9275) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: remove 'toaster-manual' from filenamesNicolas Dechesne2020-12-091-1/+1
| | | | | | | | | | | All filenames duplicate the 'manual name', which is not needed, and make all references longer than they should. Rename all files to be as consise as possible, and fix all references (From yocto-docs rev: b5a1a504caf7ffcaeca787b38bf7f11e341dfb0f) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: use absolute paths for :doc: referencesNicolas Dechesne2020-12-0910-25/+25
| | | | | | | | | | | | | | | :doc: references can be made with absolute path instead of relative path. This patch was generated with this command: sed -i 's!:doc:`\.\./!:doc:`/!g' */*.rst *.rst And a few manual fixup we made for references such as: :doc:"FOOBAR <../xxx>" Suggested-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: b7948ec7eb8172b8eae4bfa5c21aab76e123ad85) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: rename top level document in each manualNicolas Dechesne2020-12-099-26/+22
| | | | | | | | | | It is more common to call the top level document index.rst. This is what this patch is doing, along with all required references fixup. (From yocto-docs rev: 2cea7fbba9210479fc0387d7e1b80da9885558f0) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Simplify oe_git linksPaul Barker2020-12-033-4/+4
| | | | | | | | | | | | Manual links to git.openembedded.org are converted to use the oe_git directive where possible. Note that this directive can't be used in some places such as example code. (From yocto-docs rev: 64d2b5c26889356d4eb49896566cf28b9234b9cc) Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Simplify yocto_git linksPaul Barker2020-12-0311-16/+16
| | | | | | | | | | | | | | | | The yocto_git external link directive is modified to include the `/cgit/cgit.cgi` element of the URL so that we can simplify the links in the text. Manual links to git.yoctoproject.org are converted to use the yocto_git directive where possible. Note that this directive can't be used in some places such as example code. (From yocto-docs rev: 3a8ba5dcc783411c73fe49fb217cbc4d6528d9a7) Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Simplify yocto_wiki linksPaul Barker2020-12-036-12/+13
| | | | | | | | | | | | | | | The `yocto_wiki` external link directive is modified to include the `/wiki` element of the URL so that we can simplify the links in the text. Note that there are still a couple of places where this directive cannot be used, such as in the table of contents in index.rst. (From yocto-docs rev: d8aa5f93d349f27db3d03a2c4bcc205649f45a8d) Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: replace labels with references to section titleNicolas Dechesne2020-12-037-67/+67
| | | | Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: replace bitbake labels with references to corresponding titleNicolas Dechesne2020-12-035-6/+6
| | | | | | | | | | In order to remove autogenerated labels in the bibtake docs, let's use section titles in all YP docs. (From yocto-docs rev: 0f44b6027f16cc37260abc7e00042d98e2e0427f) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: replace labels with references to section titleNicolas Dechesne2020-11-202-3/+3
| | | | | | | (From yocto-docs rev: cc28ef86d557b2fc0ca3d682a2db2455049c8a2f) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/ref-variables: "PACKAGE_FEEDS_ARCHS" -> "PACKAGE_FEED_ARCHS"Robert P. J. Day2020-10-301-1/+1
| | | | | | | | | Fix single misspelling. (From yocto-docs rev: e1a47857f4ff3edb105e7fa80ff8d29dcc3ece03) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add migration info about MLPREFIX changesPaul Eggleton2020-10-301-0/+31
| | | | | | | | | | Add a migration subsection on the need to add MLPREFIX to conditional package dependencies in gatesgarth. (From yocto-docs rev: e202beabfc1282d6999fde0ced89e41c993da27f) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add migration info for image-artifact-namesPaul Eggleton2020-10-301-0/+21
| | | | | | | | | Add some info on the image-artifact-names class change in gatesgarth. (From yocto-docs rev: 71dd9d92bf58c73f5fb3bd14cf8031bfc794fd3f) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add IMAGE_LINK_NAMEPaul Eggleton2020-10-301-0/+11
| | | | | | | | | Add IMAGE_LINK_NAME to the variable glossary. (From yocto-docs rev: 370551f961a291f7090a8a40a0beea3511274bc1) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/faq: Add entry for why binaries are changed in imagesRichard Purdie2020-10-301-0/+11
| | | | | | (From yocto-docs rev: 843a91187783b2e11512c45b8dd8302b19113569) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add migration section for 3.2Paul Eggleton2020-10-302-0/+262
| | | | | | | | | | | This covers most of the changes that would require action on the part of the user that I was able to see by scouring the commits. Some of the text was borrowed from commit messages and edited. (From yocto-docs rev: 35e9349ba6417765274d7d1ce542e7e6f19dbe26) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add IMAGE_NAME_SUFFIX variablePaul Eggleton2020-10-301-0/+7
| | | | | | | | | | Add a variable glossary entry for IMAGE_NAME_SUFFIX, which was added way back in krogoth. (From yocto-docs rev: 78920a8ea5fb991606300c1fcb48aa6a7c20f8c1) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add IMAGE_VERSION_SUFFIX variablePaul Eggleton2020-10-301-8/+12
| | | | | | | | | | | Add an entry to the variable glossary for IMAGE_VERSION_SUFFIX (which was added in thud) and update the IMAGE_NAME and KERNEL_ARTIFACT_NAME entries whose defaults use this variable. (From yocto-docs rev: 1a02c4be8e348687d4f7e09aefc408aaed5f1be5) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add PSEUDO_IGNORE_PATHSPaul Eggleton2020-10-301-0/+9
| | | | | | | | | | Add a brief variable glossary entry for the new PSEUDO_IGNORE_PATHS variable. (From yocto-docs rev: a337bb317dacdeb174397e7ee8258bc74560436b) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: QA check updatesPaul Eggleton2020-10-301-7/+200
| | | | | | | | | | | | | | * Update for changes to messages * Add missing QA checks - some added recently, others several releases ago Some of this was borrowed from commit messages (with editing) - in particular thanks to Alexander Kanavin for the writeup on patch-fuzz. (From yocto-docs rev: 6a5e846a92068758e49d1810789638b6990bf83d) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: fix for features_check class changePaul Eggleton2020-10-302-21/+46
| | | | | | | | | | | distro_features_check was renamed to features_check and extended to support MACHINE_FEATURES, COMBINED_FEATURES and ANY_OF_*_FEATURES in dunfell, but the documentation still needed to be updated. (From yocto-docs rev: 274eb596582a22883e8b386a07cf32ed45a77d79) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add reference anchors for each QA checkPaul Eggleton2020-10-301-0/+36
| | | | | | | | | Make it possible to link to the explanation for a particular QA check. (From yocto-docs rev: 3f6dc24e0a371feca8fe66c1be8c86e599307854) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Document wic --offset optionJoshua Watt2020-10-261-0/+5
| | | | | | | | | | Adds documentation that describes how to use the --offset argument in a kickstart file (From yocto-docs rev: 0fbb2d71fe866b4ae7721f2f70d5b50dbc019030) Signed-off-by: Joshua Watt <JPEWhacker@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: ref-manual: ref-terms: add links to terms in glossaryQuentin Schulz2020-10-201-24/+24
| | | | | | | | | | | | | | Everything declared in a glossary has a "term-" link that is usable as an HTML anchor. The link already works, one just cannot get a link from within the ref-terms page. Let's make this possible. Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> (From yocto-docs rev: fcbb267fba968834d4d9d011fc71cc371f910447) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-variables: Given example for naming sourcesJoshua Watt2020-10-201-2/+12
| | | | | | | | | | Adds an example to SRC_URI that explains how to name sources in SRC_URI and how to associate SRCREVs and checksums with the names (From yocto-docs rev: 900af0addab7d6ea465922957f881a13012429ed) Signed-off-by: Joshua Watt <JPEWhacker@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: ref-manual: ref-system-requirements: update requirements to build ↵Quentin Schulz2020-10-201-8/+16
| | | | | | | | | | | | | | | | | | | | | | Sphinx docs Tested with containers on all supported distributions. Debian 8 (Jessie) still has Python3.4 and an old pip3, which makes it impossible to build typing module which is a requirement of "new" Sphinx python module. One cannot update to latest pip3 from within pip in Jessie's version. One cannot get a newer pip from upstream because newer pip don't support Python3.4 anymore. One cannot build with python3-sphinx package from Jessie because the package is too old (1.2.3) and does not have sphinx.ext.autosectionlabel module which appeared in 1.4 version. (From yocto-docs rev: 14da565986a573ac7e0b5c5943e55b7b74f99dd5) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: ref-manual: ref-classes: remove dropped tinderclient classQuentin Schulz2020-10-201-12/+0
| | | | | | | | | | tinderclient class was dropped in dunfell. Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> (From yocto-docs rev: 241059880bbfa61b61cf1843447e1b6d57c71ebe) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: ref-manual: migration-2.3: specify 2.3 version instead of DISTROQuentin Schulz2020-10-201-2/+2
| | | | | | | | Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> (From yocto-docs rev: 19b3ce7bc46b76207a6f3733881f3f16deab5a0d) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: ref-manual: fix typosQuentin Schulz2020-10-208-13/+13
| | | | | | | | Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> (From yocto-docs rev: f21e92f74c8357b23fd4059af6815fbba9487147) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: remove OE_INIT_FILE variableQuentin Schulz2020-10-201-3/+2
| | | | | | | | | | | | | | There's probably no need for such a variable (the name of the script is unlikely to change any time soon) and not all instances of oe-init-build-env were actually using this variable. For consistency sake, let's just remove the OE_INIT_FILE variable. Suggested-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> (From yocto-docs rev: 6fd4421283005b0ecc980e9ef25770d383b93937) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-11-15 13:53:32 +0000