summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
...
* 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>
* documentation: Add Pipenv supportJoshua Watt2020-11-123-0/+22
| | | | | | | | | | Adds a Pipfile so that Pipenv can be used to automatically install all the dependencies required to build the documentation (From yocto-docs rev: 31658ad30827d38dcd4ea83bcfb828441c7c3eca) Signed-off-by: Joshua Watt <JPEWhacker@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual-concepts: Fix the compiler bootstrap processRichard Purdie2020-11-121-22/+12
| | | | | | | | | | gcc-cross-initial and glibc-inital were removed a while ago and this flow is incorrect anyway. Fix it to match what happens (adding libgcc and libgcc-initial which are now important in this context). (From yocto-docs rev: 047bff2b79c7742abc19d549b78c175dd3b5a8f5) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* conf: update for release 3.2Nicolas Dechesne2020-11-091-1/+2
| | | | | | | | | | | switchers.js: * add 3.2 release * update 'dev' to 3.3 (From yocto-docs rev: f8b5e11bf31f2df9d86abfa5f7fcf7f3d66a4f85) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* adt-manual: delete obsolete ADT manual, and related contentRobert P. J. Day2020-10-3010-1184/+1
| | | | | | | | | | | | Since the ADT manual has long been superseded by the SDK manual, remove the entire adt-manual directory, and the references to it in the two top-level files "conf.py" and "poky.yaml". (From yocto-docs rev: 64b2e83bddf6af0439ac7089ac95e60faa696cfc) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* README: "yocto-project-qs" -> "brief-yoctoprojectqs"Robert P. J. Day2020-10-301-9/+9
| | | | | | | | | | Directory has been renamed, so fix README and add a bit more white space to keep everything lined up. (From yocto-docs rev: cdd4c705f7271e31e44a94c79b050eda1fba5945) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> 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>
* dev-manual: Add a note about prelink changing prebuild binariesRichard Purdie2020-10-301-0/+7
| | | | | | (From yocto-docs rev: 6c023ee1328bb31ececd9e1daaac67351c8320e3) 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>
* dev-manual/dev-manual-common-tasks: fix typos and use extlinksNicolas Dechesne2020-10-271-4/+5
| | | | | | | | | | * fixed a couple of typos * added a 'nicer' link to the repo using :yocto_git: (From yocto-docs rev: 14d0c205c671c4c670d7a887d307d359f70e1b7a) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: kernel-dev-faq: update outdated RDEPENDS_kernel-baseQuentin Schulz2020-10-271-1/+1
| | | | | | | | | | Since 2.5 (sumo), RDEPENDS_kernel-base has been replaced by RDEPENDS_${KERNEL_PACKAGE_NAME}-base, so let's use this one instead. (From yocto-docs rev: 0639160185969a6761e9911a166b897a015f4d59) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: kernel-dev-common: add .patch file extension to SRC_URI filesQuentin Schulz2020-10-271-3/+3
| | | | | | | | | | | | | | Patches provided in SRC_URI are only applied if their extension is .diff or .patch. The examples do not use those extensions and would probably result in user confusion as to why the patches aren't being applied to the sources. Let's fix this by giving them a .patch file extension. (From yocto-docs rev: 0858e86ed8e3e3005207980041fe4f2117750663) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: kernel-dev: fix typos, highlights and linksQuentin Schulz2020-10-276-287/+211
| | | | | | | (From yocto-docs rev: a69247321ff34cb0a2b9a8cc62020ec7f3aad834) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: add 3.1.3 and 3.0.4 release in the switcherNicolas Dechesne2020-10-261-2/+2
| | | | | | | (From yocto-docs rev: 64c7cb54e031b5b0babc8ee33dac0b9162a5f391) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual/dev-manual-common-tasks: fix warningNicolas Dechesne2020-10-261-19/+16
| | | | | | | | | | | | | A new warning was introduced in 59908cecb528 (docs: Updated the status of spdx module.) The code-block section belongs to the #3 item in the enumerated list. While at it, also fixed a typo in the text. (From yocto-docs rev: 0e301503883222da702e2418404ee6f04a25dbc1) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> 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>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-05-28 03:36:43 +0000