summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
* ref-manual: remove 'ref' from filenamesNicolas Dechesne2020-12-0927-73/+73
| | | | | | | | | | | 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-0923-48/+48
| | | | | | | | | | | 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-0925-108/+108
| | | | | | | | | | | 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>
* profile-manual: remove 'profile-manual' from filenamesNicolas Dechesne2020-12-095-13/+13
| | | | | | | | | | | 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>
* kernel-dev: remove 'kernel-dev' from filenamesNicolas Dechesne2020-12-0915-78/+78
| | | | | | | | | | | 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-0941-237/+237
| | | | | | | | | | | 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-097-18/+18
| | | | | | | | | | | 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>
* test-manual: remove 'test-manual' from filenamesNicolas Dechesne2020-12-095-11/+11
| | | | | | | | | | | 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>
* sphinx: use absolute paths for :doc: referencesNicolas Dechesne2020-12-0923-79/+79
| | | | | | | | | | | | | | | :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-0931-73/+69
| | | | | | | | | | 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-0324-91/+80
| | | | | | | | | | | | | | | | 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-0315-29/+30
| | | | | | | | | | | | | | | 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>
* dev-manual: remove unused labelsNicolas Dechesne2020-12-034-246/+0
| | | | | | | (From yocto-docs rev: e1bcfe4d8086f65511569278119be9b38b262108) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: remove unused labelsNicolas Dechesne2020-12-034-72/+0
| | | | | | | (From yocto-docs rev: ffbb7ef3fea2964f3d9ea2ad02e71692a7d96713) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: replace labels with references to section titleNicolas Dechesne2020-12-031-1/+1
| | | | | | | (From yocto-docs rev: d6ed0b0f1317778abe02f1da148d2fcf09e81fcf) 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>
* dev-manual: replace labels with references to section titleNicolas Dechesne2020-12-031-10/+11
| | | | Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* brief-yoctoprojectqs: replace labels with references to section titleNicolas Dechesne2020-12-031-1/+1
| | | | | | | (From yocto-docs rev: 1679222f3ab4a07595f8106ffc70ad1240d57377) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: replace bitbake labels with references to corresponding titleNicolas Dechesne2020-12-0310-14/+14
| | | | | | | | | | 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>
* releases.rst: add gatesgarth to current releasesAnuj Mittal2020-12-031-0/+6
| | | | | | | | (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>
* {dev,kernel,sdk}-manual: replace hardcoded release version with &DISTRO;Nicolas Dechesne2020-12-037-25/+25
| | | | | | | | | | 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>
* sphinx: add .vscode in .gitignoreNicolas Dechesne2020-12-031-0/+1
| | | | | | | (From yocto-docs rev: 0329a04de9def20b7dc24d58c301ab2a83fa3a6d) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* releases: conf: add link to 3.1.4, update to include 3.1.4Michael Halstead2020-12-033-2/+3
| | | | | | | (From yocto-docs rev: 20b7be912040ae02fb2df652fb79b09dd5f281e8) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.yaml: Define DISTRO_NAME_NO_CAP_LTSPaul Barker2020-11-241-0/+1
| | | | | | | | | | | 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>
* dev-manual-common-tasks: Re-order patch submission instructionsPaul Barker2020-11-241-97/+99
| | | | | | | | | | | | | | | | | 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>
* dev-manual-common-tasks: Describe how to propose changes to stable branchesPaul Barker2020-11-241-0/+57
| | | | | | | | | | | | | | | 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>
* dev-manual-common-tasks: Describe how to handle patch feedbackPaul Barker2020-11-241-0/+22
| | | | | | | | | | | | | 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>
* dev-manual-common-tasks: Describe git-send-email accuratelyPaul Barker2020-11-241-2/+2
| | | | | | | (From yocto-docs rev: aaadcf8b83e2a77c967dafa68b12b69025e85f5a) Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual-common-tasks: Tidy up patch submission processPaul Barker2020-11-241-38/+25
| | | | | | | | | | | Reduce duplication by pulling out the common steps of committing changes locally from the steps of submitting those changes via the pull request scripts or via email. (From yocto-docs rev: b80842496a8b5142e3a0b054cc99aee66649fcef) Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual-common-tasks: Update & move patchwork referencePaul Barker2020-11-241-10/+13
| | | | | | | | | | | | Add a link to our patchwork instance and note how submitted patches are checked for common mistakes. This note is moved to the section on submitting patches via email as that is the place where most users will run into patchwork/patchtest. (From yocto-docs rev: 76506bc6125b551c5aa9c45f2b1e7b89e6bf6eae) Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual-common-tasks: Fix refs to testing branchesPaul Barker2020-11-241-12/+21
| | | | | | | | | | | | After discussions on IRC with Ross we concluded that the `ross/mut` branch shouldn't really be listed in the docs as it's more of a personal test branch. Instead we should list the -next branches for openembedded-core and poky. (From yocto-docs rev: a6bb1f7b677ea0b540735497fbbbda64ce3653ce) Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/README: Refer to top-level README for contributionsPaul Barker2020-11-201-0/+6
| | | | | | | | | | This may help anyone looking for patch contribution guidelines in the documentation directory itself. (From yocto-docs rev: 276740dd3780b0bdf04996efeed3c237fd26da1f) Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* conf.py: Add oe_git directivePaul Barker2020-11-201-0/+1
| | | | | | | | | This simplifies linking to git repositories on openembedded.org. (From yocto-docs rev: 03e13ca4d013e7712216a66eb4cdeb4a456be6a9) Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Makefile: enable parallel buildNicolas Dechesne2020-11-201-1/+1
| | | | | | | | | | | | >From sphinx-build man page: -j N build in parallel with N processes where possible (special value "auto" will set N to cpu-count) (From yocto-docs rev: 1847aeea8b88c84f821610803264955e51e31d2f) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: remove unused labelsNicolas Dechesne2020-11-204-48/+0
| | | | | | | (From yocto-docs rev: 00551ac92a24fb1dcef966b585bf612aab228934) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: remove unused labelsNicolas Dechesne2020-11-204-56/+0
| | | | | | | (From yocto-docs rev: 7a57d4f34058d86f0494782b39656330a7236b20) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* profile-manual: remove unused labelsNicolas Dechesne2020-11-202-50/+0
| | | | | | | (From yocto-docs rev: 4ee8a38f23f600fb9dac5d25bd884a195f7d72c0) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: remove unused labelsNicolas Dechesne2020-11-205-16/+0
| | | | | | | (From yocto-docs rev: 98c0f58fb88fe8dffb00751826bc2927fd488a42) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide: remove unused labelsNicolas Dechesne2020-11-201-20/+0
| | | | | | | (From yocto-docs rev: 555625c8a4c8cd444dce3b31090dd717c300d3ce) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* test-manual: remove unused labelsNicolas Dechesne2020-11-203-44/+0
| | | | | | | (From yocto-docs rev: 3f7a065dafd24a3c1e6b7f68b522352606f8fd7b) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: replace labels with references to section titleNicolas Dechesne2020-11-202-6/+6
| | | | | | | (From yocto-docs rev: 0a0a5d3ad6c2e551db0d43b1e76b8c459c347dc5) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: replace labels with references to section titleNicolas Dechesne2020-11-201-7/+8
| | | | | | | (From yocto-docs rev: faa9ad6749d3dba2f49699e83840eacdb3374795) 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>
* sdk-manual: replace labels with references to section titleNicolas Dechesne2020-11-201-1/+1
| | | | | | | (From yocto-docs rev: 90aba9699ad6639f72ab4fdc25684a748df37fb2) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* what-i-wish-id-known: replace labels with references to section titleNicolas Dechesne2020-11-201-1/+1
| | | | | | | (From yocto-docs rev: 27779317d5406d2f79c907bd1d6d5d3748afed7e) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: releases: add link to 3.1.3Nicolas Dechesne2020-11-131-0/+1
| | | | | | | (From yocto-docs rev: bf395d0af044f6e9826a8235b760b2d285602b26) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* conf.py: Improve TOC and Outline depth in PDF outputPaul Barker2020-11-131-0/+5
| | | | | | | | | | | | | | | | | | | The default PDF output shows only chapter headings in the table of contents and in the outline (aka PDF bookmarks). We should override these defaults to set something more suitable. With a depth of 2 for the TOC we see both section and subsection headings which is enough to get the list of classes in the reference manual and the list of topics under "Common Tasks" in the development manual. Going to a deeper level would make the TOC unwieldy but we do want to make sure we can navigate more precisely using the outline (commonly shown in a left tab in PDF viewers) so we set the depth to 5 for the outline. (From yocto-docs rev: 5db16d3b01da0a138b6413347fcf2321a1bfae08) Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.yaml: updates for 3.2Nicolas Dechesne2020-11-121-8/+8
| | | | | | | | | Updates global variables for 3.2 / Gategarth release. (From yocto-docs rev: 505d4551d47db03b47164321e4559023d9473e21) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.yaml: remove unused variablesNicolas Dechesne2020-11-121-47/+0
| | | | | | | | | | | | | | | There are plenty of variables in poky.yaml which are not used anywhere in the docs. So let's remove them. We can always add the one we need later. Note ORGEMAIL could be used in boilerplate.rst, however this file is not parsed but included, and somehow the yocto-vars.py exenstion does not process this file, so we cannot use a variable there. (From yocto-docs rev: f1164d2e6401d93e0b4e484b090abbe0f72a6ac7) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-05-06 17:36:31 +0000