summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
...
* toaster-manual: fix description of introduction videoMichael Opdenacker2023-01-061-3/+2
| | | | | | | | | | The video referred to didn't correspond to the latest Poky releases. (From yocto-docs rev: 29780dee7b183ebb13571dcab8e20d22bfbfeb4b) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: add release-notes for 4.0.6Lee Chee Yang2023-01-062-0/+314
| | | | | | | | | (From yocto-docs rev: 5b5c2af6127eabda8eb07645546fa2cdfc462154) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Takayasu Ito <ito@lineo.co.jp> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: fix 4.2 migration note issuesMichael Opdenacker2023-01-062-135/+1
| | | | | | | | | | | - Eliminate this warning: WARNING: Title underline too short. - Remove a leftover patch file (From yocto-docs rev: 15f1f9b234ba81177ff5fafdb3d42c002daffa56) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: prepare 4.2 migration notesMichael Opdenacker2022-12-185-0/+220
| | | | | | | (From yocto-docs rev: 9276628507233aef554450c807d8456a0eb00225) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/poky.yaml.in: update minimum python version to 3.8Michael Opdenacker2022-12-181-1/+1
| | | | | | | | | | Now required by Bitbake: https://git.openembedded.org/bitbake/commit/?id=744310f360d2288ac2ef07745abc86852126b5b9 (From yocto-docs rev: 9f675b996f145349210adf4fea8e2e55f57c6c77) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: create references to buildtoolsMichael Opdenacker2022-12-1813-28/+45
| | | | | | | | | On the side, also simplify a reference to the section describing them. (From yocto-docs rev: 0c13a7f9ccee4ddc9c6034d03f47625a09598cec) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/system-requirements.rst: update buildtools instructionsMichael Opdenacker2022-12-181-24/+17
| | | | | | | | | | | | - Stop mentioning the buildtools i586 environment setup file, no longer available. - Remove trivial or redundant instructions. (From yocto-docs rev: 589c7b22b8279ebc62a72106969fde2af92f8753) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/resources.rst: improve description of mailing listsMichael Opdenacker2022-12-181-2/+4
| | | | | | | | | | | | - Mention docs@lists.yoctoproject.org - Refer to the specific web page about all mailing lists, instead of just the website home page. (From yocto-docs rev: b415769d73dde835ec204d70ae35be2a58251961) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: final removal of SERIAL_CONSOLE variableMichael Opdenacker2022-12-182-22/+6
| | | | | | | | | | This deprecated variable has been removed for good through https://git.openembedded.org/openembedded-core/commit/?id=9d053af1fb570b4e3483de4ecd6827e1e0be61b7 (From yocto-docs rev: db22748d8a2bc4c53c6415537c772d2c49220aec) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: define proper numbered listsMichael Opdenacker2022-12-1828-347/+347
| | | | | | | | | | Using "#." instead of "1.", "2.", "3.", etc. (From yocto-docs rev: 11c2585acd0fa6c330702af2359ce5a9e47cde1f) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/images.rst: fix unnumbered listMichael Opdenacker2022-12-181-3/+3
| | | | | | | | (From yocto-docs rev: 9a51f1ce0de9152d0cdca4bf1f67546fd6599448) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manual: improve documentation about using external toolchainsMichael Opdenacker2022-12-183-30/+37
| | | | | | | | | | | | | | | | | - Remove the redundant FAQ entry about this topic, already covered in a specific section of the Development Tasks manual - Document the TOOLCHAIN_LOCATION variable - Expand both the Development Tasks manual and the TCMODE variable description using details from the FAQ entry. - Mention the "meta-arm-toolchain" layer too. (From yocto-docs rev: 53faa54a8e6311b4d3d41d96cb1a497d0f6502fb) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: update references to release notesMichael Opdenacker2022-12-182-11/+7
| | | | | | | | | Now part of the Yocto Project manual. (From yocto-docs rev: fe23084f746f0959afbf7d4a49e00299e39fba09) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/resources.rst: fix formatingMichael Opdenacker2022-12-181-21/+21
| | | | | | | | | | Simplify formating for better looking output. For example, mosts paragraphs had only ther ":" character in boldface. (From yocto-docs rev: 833ea5d06dd46e79b2d02752f2c41a4c3a54a2f9) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: fix double colonsMichael Opdenacker2022-12-1818-159/+94
| | | | | | | | | | | | | | | Fixing double colons appearing alone on a line, while they could be put at the end of the previous line. Sometimes placing a note after the quoted text to avoid such a situation. It's more natural too not to have a note between the introduction text and the quoted section. (From yocto-docs rev: fb054622f5119444eb947fe580253f37e0d872c6) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add missing SPDX license header to source filesMichael Opdenacker2022-12-1839-0/+78
| | | | | | | (From yocto-docs rev: 86737cc4583f1ef43bda10033c801329ba0c8b81) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add missing references to variablesMichael Opdenacker2022-12-1828-191/+188
| | | | | | | | [YOCTO #14508] (From yocto-docs rev: 7878a21be8fb6c7a1ab88ae44aa5f7bf0079391a) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add reference to yocto-docs git repository to page footerMichael Opdenacker2022-12-181-1/+1
| | | | | | | | | To make documentation sources easier to find. (From yocto-docs rev: 99369e9aca3446a22d710c67f5fd5ace07b713f6) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add references to variables only documented in the BitBake manualMichael Opdenacker2022-12-181-0/+204
| | | | | | | | | | | | | | | This makes the Yocto Project manual variable list and index more useful, not missing any potentially useful variable. The price to pay is that a reference to such variables now has to go through the intermediate reference in the Yocto Project variable list, instead of going straight to the Bitbake manual. (From yocto-docs rev: 3d308812cd9aa906890a0f8562fc28c1cd8aaab6) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual/runtime-testing.rst: fix oeqa runtime test pathMikko Rapeli2022-12-011-5/+5
| | | | | | | | | | | | It's "runtime/cases" in master and kirkstone. If layer specific tests are in "runtime" directory, they will not be found. (From yocto-docs rev: 8d0d56cea5373c928feaaba316038c84130b52e7) Signed-off-by: Mikko Rapeli <mikko.rapeli@linaro.org> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual/sbom.rst: minor correctionsMichael Opdenacker2022-12-011-4/+5
| | | | | | | (From yocto-docs rev: 56bf7a3e521e7368e620685354aa89f540bb7564) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: split dev-manual/common-tasks.rstMichael Opdenacker2022-12-0176-12038/+12137
| | | | | | | | | | | | | | A 500 KB source file is always harder to manage, and can have section title conflicts. So, the "Common Tasks" document is gone and all its constituents are moved up one level. You now have 40 chapters in the Development Tasks Manual. (From yocto-docs rev: 8a45bc469411410020b8e688c137395fcaf3761b) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: add release-notes for 4.1.1Chee Yang Lee2022-12-012-0/+318
| | | | | | | | (From yocto-docs rev: 15140d5f53035bc6276fb890d89e8c2513e832da) Signed-off-by: Chee Yang Lee <chee.yang.lee@intel.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: simplify .gitignore filesMichael Opdenacker2022-12-011-0/+1
| | | | | | | | | | | Remove obsolete and unnecessary ignores. Just found one .pyc file in documentation/sphinx/__pycache__, so ignored that directory. (From yocto-docs rev: 887ca562eb6f79674825a06c0fe2e8108fb7c8c4) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/classes.rst: remove reference to sip.bbclassMichael Opdenacker2022-12-011-8/+0
| | | | | | | | | Removed in version 2.2 (From yocto-docs rev: ff2ad887bcac5dd209ce781488e1ca73c43e148b) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: fix paragraphs with the "inherit" wordMichael Opdenacker2022-12-018-82/+64
| | | | | | | | | | | Nothing wrong with this word, but instances of "inherit" were looked for while looking for class names without references. Fixing alignment and sometimes syntax. (From yocto-docs rev: c418c645a360e74ebb91765a3041336f03097e0d) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add missing references to classesMichael Opdenacker2022-12-0121-156/+182
| | | | | | | | | | | Sometimes fixing line length in modified paragraphs too. [YOCTO #14508] Reported-by: Quentin Schulz <foss@0leil.net> (From yocto-docs rev: 885b60f5540849bf19240a01a77efce1d1b5d9f0) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* qemu.rst: slirp port forwarding detailsAtanas Bunchev2022-12-011-1/+24
| | | | | | | | | | | | Explain the default behavior of `runqemu slirp`. Explain how to forward ports from the guest to the host machine. (From yocto-docs rev: 239314da5998f27d0e3a0f2e538216e852bb19d8) Signed-off-by: Atanas Bunchev <atanas.bunchev@konsulko.com> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* release-notes: use oe_git and yocto_git macrosMichael Opdenacker2022-11-1012-61/+61
| | | | | | | | | | | | | | As in the rest of the manuals; this is more future proof than using hard coded URLs. While doing this, also replacing https://git.yoctoproject.org/git/<repo> links (used by mistake instead of https://git.yoctoproject.org/<repo>) by :yocto_git:`/repo`. (From yocto-docs rev: ac844062400a7bf4732ea6ee639a478b1b77b83e) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: expand PARALLEL_MAKE descriptionMichael Opdenacker2022-11-101-12/+16
| | | | | | | | | | Explain that this variable apply not only to make, but also to ninja, and to other build tools which support parallel jobs. (From yocto-docs rev: d3fe2aba3948040a01b9068df5085453ad65309c) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: expand BB_NUMBER_THREADS descriptionMichael Opdenacker2022-11-101-0/+27
| | | | | | | | | | Explain that reducing its value to reduce system load is not sufficient if PARALLEL_MAKE is not reduced as well. (From yocto-docs rev: f4986faa5576ec1c146e606220421a686c4a9b57) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* qemu.rst: audio: reference to Command-Line optionsAtanas Bunchev2022-11-101-2/+3
| | | | | | | | | | | | The previous statement can cause confusion, because this is the first time when the `audio` argument is mentioned. (From yocto-docs rev: c8aa98a4b21d056ebf49b8ab43838989e9185c81) Signed-off-by: Atanas Bunchev <atanas.bunchev@konsulko.com> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: poky.yaml.in: remove pylint3 from Ubuntu/Debian host dependenciesQuentin Schulz2022-11-101-1/+1
| | | | | | | | | | | | | | | | | | It is not actually needed outside of the autobuilder and since the package got renamed in Ubuntu 20.04 and later to pylint, it was giving the users an incorrect command line to run and would fail all the time, better remove it instead of trying to handle Debian/recent Ubuntu differences in the documentation. Moreover, the other supported host distributions didn't have pylint listed as a dependency, proving that it's indeed not needed. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 9f255dc3c32a4c9b2185e6448bde3357fd5135b2) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: ref-manual: classes: add missing closing parenthesisQuentin Schulz2022-11-101-1/+1
| | | | | | | | | | | The closing parenthesis is missing in the sentence so let's add it. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 93bb2654905ad7f32082bb7acd3630ef390dc4b9) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: ref-manual: classes: fix section name for github-releasesQuentin Schulz2022-11-101-2/+2
| | | | | | | | | | | | All other classes are suffixed with .bbclass so let's stay consistent and add it to github-releases section too. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 461bc36839278e69a3d2511ca15fae80a6140d77) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration guides: add release notes for 4.0.5Lee Chee Yang2022-11-102-0/+197
| | | | | | | | (From yocto-docs rev: f464b17b8c2cd29d6c1a9417c3b9d0956323ab0e) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add shortcut for Wikipedia linksMichael Opdenacker2022-11-0719-70/+58
| | | | | | | (From yocto-docs rev: 47101c15cce156ab71683cac1c42ab94f43bdbee) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: remove xterm requirementsPaulo Neves2022-11-071-5/+5
| | | | | | | | | | | | | According to [1] xterm is no longer required. Update the manual accordingly. Related to Bug [YOCTO #14873]. [1] https://git.openembedded.org/openembedded-core/commit/?id=ddb825c87dd3e59d50841a993080a00d1459b1e7 (From yocto-docs rev: 2b5d3be5677efc19f6610309a938bca9563a54d1) Signed-off-by: Paulo Neves <ptsneves@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: document "mime-xdg" class and MIME_XDG_PACKAGESMichael Opdenacker2022-11-074-5/+33
| | | | | | | (From yocto-docs rev: dabd2e95cf8ba8ed620bfd135deb6cfcf5d74b16) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: terms.rst: add reference to new SBOM/SPDX section in dev manualMichael Opdenacker2022-11-071-1/+3
| | | | | | | (From yocto-docs rev: 908c985b0a9ad98d1e6610c36a057501be1900e9) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: classes.rst: expand documentation of create-spdx classMichael Opdenacker2022-11-071-2/+20
| | | | | | | (From yocto-docs rev: 4c6a4121d7f63e56f2743216e8219f92ed5eb94e) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: common-tasks.rst: add section about SPDX / SBOM generationMichael Opdenacker2022-11-071-35/+66
| | | | | | | Also stop refering to the meta-spdxscanner class, no longer relevant. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: variables.rst: document spdx-create class variablesMichael Opdenacker2022-11-071-0/+82
| | | | | | | (From yocto-docs rev: fd9ee9e1701a90c19d4957ec387e0ad17757aa06) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: terms.rst: add SBOM and SPDX termsMichael Opdenacker2022-11-071-0/+26
| | | | | | | (From yocto-docs rev: 2c53ac40e99a7957736276c5bf925b3f81544aa5) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: common-tasks.rst: fix typosUlrich Ölmann2022-11-071-13/+13
| | | | | | | | (From yocto-docs rev: 680f48a94cec063779797c55a9bfe461289a98e3) Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: use references to the "Build Directory" termMichael Opdenacker2022-10-2827-376/+294
| | | | | | | | | | | | | | Replace instances of "Build Directory" and "build directory" (when applicable) by :term:`Build Directory` as already done in most places. Doing this, fix the indentation of the paragraphs with this term. (From yocto-docs rev: dce50679242d39f133e0cde5c8483b5e69f3eb54) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add missing references to SDKMACHINE and SDK_ARCHMichael Opdenacker2022-10-283-16/+14
| | | | | | | | | Doing this, fix the odd identation of the corresponding paragraphs (From yocto-docs rev: e319b3bf4eb6420949372e699d60c7383945e513) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: stop referring to the meta-openembedded repo from GitHubMichael Opdenacker2022-10-284-12/+8
| | | | | | | (From yocto-docs rev: de6e7c05fbcff99a6f1fe2a2bf889b559b9b576b) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: replace "_" by "__" in external linksMichael Opdenacker2022-10-286-13/+12
| | | | | | | (From yocto-docs rev: 25142cd8121fdd6a8e0524fc8417fc666c498981) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Documentation/README: formalize guidelines for external link syntaxMichael Opdenacker2022-10-281-0/+13
| | | | | | | (From yocto-docs rev: f5d10ceed943270d7bcfa31b5936f37a60669c7f) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-11-14 06:59:27 +0000