summaryrefslogtreecommitdiffstats
path: root/documentation
AgeCommit message (Collapse)Author
2021-01-20releases: conf: add link to 3.1.5, update to include 3.2.1 & 3.1.53.3_M2Michael Halstead
(From yocto-docs rev: 5c94f8183733bf266cd6153434b5eed22d1914c6) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-20ref-manual: Clarify recommended operator for PROVIDESJoshua Watt
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>
2021-01-20documentation: Prevent building documentation with an outdated version of sphinxYoann Congal
Building with a outdated version of Sphinx print warnings that does not appear on up-to-date sphinx. This patch prevent building the documentation with any version older than 3.1 (First version to build without warnings in my tests) See threads "documentation: Add a simple Sphinx extension to check its version" https://lists.yoctoproject.org/g/docs/topic/patch_documentation_add_a/79919516 and "toaster-manual: Fix a warning related to the code-block directive" https://lists.yoctoproject.org/g/docs/topic/patch_toaster_manual_fix_a/79656195 (From yocto-docs rev: 4de0f3dd4d5df0a0700f704a599bb41726d15a5f) Signed-off-by: Yoann Congal <yoann.congal@smile.fr> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-20ref-manual/ref-classes: update kernel-fitimage with Initramfs bundle and ↵Abdellatif El Khlifi
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>
2021-01-20docs: fix missing & and ; surrounding references from poky.yamlQuentin Schulz
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>
2021-01-20dev-manual: Add usage of /sysroot-only in SYSROOT_DIRSDiego Sueiro
(From yocto-docs rev: adc59efc4a6c56cc3b4594a411ae618d256d6ba2) Signed-off-by: Diego Sueiro <diego.sueiro@arm.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-15common-tasks.rst: Fix GNU_HASH in hello.bbLeon Anavi
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>
2021-01-15documentation: Fix a Concpets -> Concepts typoYoann Congal
(From yocto-docs rev: 78bdf1c25c5c546c35b5a0d246aa1bbd70d5eace) Signed-off-by: Yoann Congal <yoann.congal@smile.fr> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-05variables: Add documentation for KERNEL_DTC_FLAGSOvidiu Panait
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>
2021-01-04ref-manual: terms: Fix poky tarball root folderElvis Stansvik
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>
2020-12-24documentation: Use https links where possiblePaul Barker
(From yocto-docs rev: cd4c5e9928866f910ac97cf3e0612e6245da30bd) Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-24ref-manual: Simplify oe_lists linkPaul Barker
(From yocto-docs rev: 9521c5b5538295d3bfa6b9b07cbf67b62b78a0dc) Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-24profile-manual: Simplify yocto_bugs linkPaul Barker
(From yocto-docs rev: 5cd7790baa27cf4222419cf562fc89ef61833c7a) Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-24documentation: Simplify remaining yocto_home linksPaul Barker
(From yocto-docs rev: e0151e039f96c1548e2ec39ae24d4b0276f49434) Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-24documentation: Simplify layerindex and layer linksPaul Barker
(From yocto-docs rev: b157d57cc50b0a9cfaa062fa0e966b4d29eceeec) Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-24documentation: Simplify oe_wiki and oe_home linksPaul Barker
(From yocto-docs rev: 6867f54f349edede37c4085194f51342c24297ed) Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-24ref-manual: use consistent capitalisation of U-BootPaul Eggleton
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>
2020-12-24variables: Add documentation for new kernel-fitimage varsPaul Eggleton
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>
2020-12-24variables: explicitly state that UBOOT_MKIMAGE_DTCOPTS is optionalPaul Eggleton
(From yocto-docs rev: 0ba5591c4e8dd194f87837556cedb2b9979bc6df) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-24variables: clarify KERNEL_ALT_IMAGETYPE referencePaul Eggleton
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>
2020-12-24classes: minor corrections to kernel-fitimage sectionPaul Eggleton
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>
2020-12-15releases: conf: add link to 3.2.1, update to include 3.2.1Michael Halstead
(From yocto-docs rev: b268b1b190861cb203fa642e57794acb402280a7) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-09ref-manual: remove 'ref' from filenamesNicolas Dechesne
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>
2020-12-09sdk-manual: remove 'sdk' from filenamesNicolas Dechesne
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>
2020-12-09overview-manual: remove 'overview-manual' from filenamesNicolas Dechesne
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>
2020-12-09profile-manual: remove 'profile-manual' from filenamesNicolas Dechesne
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: 44405490888960208058d016e387507e21c9f478) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-09kernel-dev: remove 'kernel-dev' from filenamesNicolas Dechesne
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>
2020-12-09dev-manual: remove 'dev-manual' from filenamesNicolas Dechesne
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>
2020-12-09toaster-manual: remove 'toaster-manual' from filenamesNicolas Dechesne
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>
2020-12-09test-manual: remove 'test-manual' from filenamesNicolas Dechesne
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: 1b1f2fbd9283ba53c74ea4231ab4391627eb4187) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-09sphinx: use absolute paths for :doc: referencesNicolas Dechesne
: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>
2020-12-09sphinx: rename top level document in each manualNicolas Dechesne
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>
2020-12-03ref-manual: Simplify oe_git linksPaul Barker
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>
2020-12-03documentation: Simplify yocto_git linksPaul Barker
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>
2020-12-03documentation: Simplify yocto_wiki linksPaul Barker
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>
2020-12-03dev-manual: remove unused labelsNicolas Dechesne
(From yocto-docs rev: e1bcfe4d8086f65511569278119be9b38b262108) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-03overview-manual: remove unused labelsNicolas Dechesne
(From yocto-docs rev: ffbb7ef3fea2964f3d9ea2ad02e71692a7d96713) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-03sdk-manual: replace labels with references to section titleNicolas Dechesne
(From yocto-docs rev: d6ed0b0f1317778abe02f1da148d2fcf09e81fcf) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-03ref-manual: replace labels with references to section titleNicolas Dechesne
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-03dev-manual: replace labels with references to section titleNicolas Dechesne
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-03brief-yoctoprojectqs: replace labels with references to section titleNicolas Dechesne
(From yocto-docs rev: 1679222f3ab4a07595f8106ffc70ad1240d57377) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-03sphinx: replace bitbake labels with references to corresponding titleNicolas Dechesne
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>
2020-12-03releases.rst: add gatesgarth to current releasesAnuj Mittal
(From yocto-docs rev: 54f84f3716f989856e3129208177a1f4f814a9a6) Signed-off-by: Anuj Mittal <anuj.mittal@intel.com> Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-03{dev,kernel,sdk}-manual: replace hardcoded release version with &DISTRO;Nicolas Dechesne
In the Docbook files we had DISTRO, but somehow it was lost during the migration to Sphinx. (From yocto-docs rev: d10bb13070039e17281fccc5c1a64b5bfed30543) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-03sphinx: add .vscode in .gitignoreNicolas Dechesne
(From yocto-docs rev: 0329a04de9def20b7dc24d58c301ab2a83fa3a6d) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-03releases: conf: add link to 3.1.4, update to include 3.1.4Michael Halstead
(From yocto-docs rev: 20b7be912040ae02fb2df652fb79b09dd5f281e8) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-11-24poky.yaml: Define DISTRO_NAME_NO_CAP_LTSPaul Barker
This allows us to reference the branch name for the latest LTS release (currently dunfell) in the text. When the current release is an LTS, this variable will be equal to DISTRO_NAME_NO_CAP. (From yocto-docs rev: d5022ebbba31433761d84b1e5552dd86e08745d9) Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-11-24dev-manual-common-tasks: Re-order patch submission instructionsPaul Barker
New contributors to the project will usually be following the steps to submit patches directly via email as they may not have commit access to a contrib repository. For shorter series of patches this is the more common workflow which we see anyway. The documentation here is updated to reflect this, addressing the email submission process first and then the pull request process. The new opening paragraph for the section on submitting pull requests is taken from the "How to submit a patch to OpenEmbedded" page on the OE wiki. (From yocto-docs rev: 0911e61e083ae4369438b431e83efe8465f663fd) Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-11-24dev-manual-common-tasks: Describe how to propose changes to stable branchesPaul Barker
The documentation on submitting changes to the project should cover the ways in which the process differs for stable branches. These changes add a brief description of the typical policy for handling changes to stable branches and give some steps to follow when proposing changes to these branches. The information is based on my personal experience and on the existing content of the "How to submit a patch to OpenEmbedded" page on the OE wiki. (From yocto-docs rev: 2a835ae0925f4286769fb050b3409732ba79779d) Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-11-24dev-manual-common-tasks: Describe how to handle patch feedbackPaul Barker
The contribution guidelines would benefit from a brief section on how to address feedback from patch reviewers and how to re-submit amended patches. The information here is based on my personal experience and on the existing notes on the "How to submit a patch to OpenEmbedded" page on the OE wiki. (From yocto-docs rev: fcff5c524fdf2f465153319d0fdc6fb557b588dd) Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
generated by cgit 1.2.3-korg (git 2.39.0) at 2024-05-03 01:20:07 +0000