summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
Commit message (Collapse)AuthorAgeFilesLines
...
* ref-manual: classes.rst: improvements to cmake class documentationMichael Opdenacker2023-02-242-11/+24
| | | | | | | | | | | | - Fix quoting for path to cmake modules - Document OECMAKE_GENERATOR variable - Style simplifications (From yocto-docs rev: ecdc1775e27717ec87442575f65b1f24ca2b0348) 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: new-recipe.rst: restructure examplesMichael Opdenacker2023-02-241-1/+1
| | | | | | | | | | | | | | | | To make it possible to add more examples (CMake, Meson, Go, Rust...) - Change section title names - Adjust paragraph line length - Have the Autotools example after the one with a custom Makefile, corresponding to an increasing level of complexity. - Clarify that GNU make and the Autotools are used to build the applications, not by these applications. (From yocto-docs rev: 6f313e673fe4d2878c8166619c27c4958af73615) 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>
* ref-manual: classes.rst: add python-setuptools3_rust and python_pyo3 classesMichael Opdenacker2023-02-241-0/+25
| | | | | | | | | | (From yocto-docs rev: 65d41f164354494dae52949ce0532fd855de16ec) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Cc: Tim Orling <ticotimo@gmail.com> Cc: Alex Kiernan <alex.kiernan@gmail.com> Cc: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: refer to MACHINE variable instead of KMACHINEUlrich Ölmann2023-02-241-1/+1
| | | | | | | | | | | | | Although in the example case of a "raspberrypi2" the variable KMACHINE has the same value as MACHINE, only the latter is an allowed override. So do not set the reader on the wrong track. Suggested-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> (From yocto-docs rev: 565ebcfe3ed68a9ea036f11cddafb36023f72099) Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev,ref-manual: fix old override syntaxUlrich Ölmann2023-02-241-1/+1
| | | | | | | | | | | | | | Additionally use more common syntax to indicate that an actual machine name is supposed to be filled in for a concrete use case as has been suggested by Peter Kjellerstedt (and particularly no KMACHINE). Furthermore add missing quotes in the reference manual. Suggested-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com> (From yocto-docs rev: b66c035970f860b65cf712285f2d5a023620e6c3) Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: document Rust classesMichael Opdenacker2023-02-101-0/+78
| | | | | | | (From yocto-docs rev: 3f3f0ad23f31fb5bb7b550dbe18bbedb1449b3ca) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: improve "devtool check-upgrade-status" explanationsMichael Opdenacker2023-02-101-8/+11
| | | | | | | | | | - Fix broken link to a .bb file - Clarify the explanations (From yocto-docs rev: 937ef39cb4d04da388b1945d741820089daa2780) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: replace unnecessary uses of 'yocto_docs' by internal referencesMichael Opdenacker2023-02-102-2/+2
| | | | | | | | | | | | | These :yocto_docs: references were making external references to another section of the manual, using the https://docs.yoctoproject.org website. It's actually better to use internal references (:doc: for an entire document, and :ref: for a specific section, as they will cause an error in Sphinx if one day they are no longer valid. (From yocto-docs rev: 0beff9dea986a2ea4b496180b29a99490416eeeb) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: variables.rst: fix broken hyperlinkMichael Opdenacker2023-02-101-1/+1
| | | | | | | (From yocto-docs rev: 048db4183ff314e1c6b51be4dc10f0dbc2aa8401) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: variables: FIT_KERNEL_COMP_ALG: add lzoRichard Leitner2023-02-101-2/+3
| | | | | | | | | | | | | | OE-Core rev f1257d61b76d027d4ece734439993b6bf4e48907 introduced support for using lzo as compression algorithm for fitImage contained kernel images. This patch adds the corresponding documentation to FIT_KERNEL_COMP_ALG and FIT_KERNEL_COMP_ALG_EXTENSION. (From yocto-docs rev: aba0ab326ea72ff10492e73b452b51d1beaa50d6) Signed-off-by: Richard Leitner <dev@g0hl1n.net> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: fix typo in the MLPREFIX descriptionLuca Ceresoli2023-01-251-1/+1
| | | | | | | | (From yocto-docs rev: 71535ccea091f130e94339072e3c579661dbf3d8) Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: initial documentation for go and go-mod classesMichael Opdenacker2023-01-252-0/+90
| | | | | | This addresses [YOCTO #14582] Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/system-requirements.rst: recommend buildtools for not supported ↵Michael Opdenacker2023-01-061-3/+8
| | | | | | | | | | | | distros Also minor correction to supported distribution notes (From yocto-docs rev: df8f862042633594846a93a1b7702fc01bc32ae0) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Suggested-by: Alexander Kanavin <alex.kanavin@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: simplify references to classesMichael Opdenacker2023-01-066-697/+632
| | | | | | | | | | | | | | | Now that .bbclass is removed from class section titles. We can now have, for example, :ref:`ref-classes-insane` instead of :ref:`insane <ref-classes-insane>`. Then, when necessary, rework paragraphs so that they have lines of even length, not exceeding 80 characters. (From yocto-docs rev: e76190e3be78c1e483bec0469f1e437dbf8f3791) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Suggested-by: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/classes.rst: remove .bbclass from section titlesMichael Opdenacker2023-01-061-294/+294
| | | | | | | | | | | | This is unnecessary and allows to simplify the references to such sections, most of which are removing the .bbclass extension anyway, for example in :ref:`insane <ref-classes-insane>`. (From yocto-docs rev: 44fbdb909c47553fecb7f9eb37f065a8768bc922) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Suggested-by: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: create references to buildtoolsMichael Opdenacker2022-12-182-14/+32
| | | | | | | | | 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-181-13/+0
| | | | | | | | | | 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-183-18/+18
| | | | | | | | | | 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-182-22/+17
| | | | | | | | | | | | | | | | | - 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-182-29/+14
| | | | | | | | | | | | | | | 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 references to variablesMichael Opdenacker2022-12-184-18/+18
| | | | | | | | [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>
* 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>
* manuals: split dev-manual/common-tasks.rstMichael Opdenacker2022-12-0113-107/+107
| | | | | | | | | | | | | | 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>
* 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-013-30/+27
| | | | | | | | | | | 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-013-68/+73
| | | | | | | | | | | 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>
* 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>
* 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>
* manuals: add shortcut for Wikipedia linksMichael Opdenacker2022-11-075-21/+19
| | | | | | | (From yocto-docs rev: 47101c15cce156ab71683cac1c42ab94f43bdbee) Signed-off-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-073-4/+32
| | | | | | | (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>
* 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>
* manuals: use references to the "Build Directory" termMichael Opdenacker2022-10-285-80/+70
| | | | | | | | | | | | | | 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: stop referring to the meta-openembedded repo from GitHubMichael Opdenacker2022-10-282-8/+5
| | | | | | | (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-283-8/+8
| | | | | | | (From yocto-docs rev: 25142cd8121fdd6a8e0524fc8417fc666c498981) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: classes.rst: improve documentation for cve-check.bbclassMikko Rapeli2022-10-281-2/+50
| | | | | | | | | | | It is a quite important tool for maintaining yocto based products so documentation should include the best practices. (From yocto-docs rev: 3f7d09fc3c96f29ab80a2cb893c9b4b19a75a769) 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>
* ref-manual: variables.rst: add documentation for CVE_VERSIONMikko Rapeli2022-10-281-0/+12
| | | | | | | | | | Related to cve-check.bbclass. (From yocto-docs rev: 1218775a9b32ac16556645c5d186007c19a5baf4) 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>
* ref-manual: add info on buildtools-make-tarballPaul Eggleton2022-10-281-1/+25
| | | | | | | | | | | | | PENDING ON THIS OE-CORE PATCH: install-buildtools: support buildtools-make-tarball and update to 4.1 https://lists.openembedded.org/g/openembedded-core/message/171522 Cover the use case and the new provided tarball. (From yocto-docs rev: 3a06c35d059d7d43f7eb33a4f490f5d76afe6cb6) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add wic command bootloader ptable optionAdrian Freihofer2022-10-281-6/+11
| | | | | | | | | | Reordering the bootloader command options alphabetically (From yocto-docs rev: 9d43fcf8ba023be1350ed2b26482d2d5e44cf0cb) Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: classes.rst: add links to all references to a classMichael Opdenacker2022-10-251-227/+225
| | | | | | | | | | | | | | | | | | | | | | | | [YOCTO #14508] Reported-by: Quentin Schulz <foss@0leil.net> (From yocto-docs rev: 664b658d9d23bb97b236bc0d09c9d3f118c582fc) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> -- Doing this to consistently replace any reference to a class by the corresponding link. This is a bit trivial within the declaration of a class, but helps making sure that this rule applies everywhere. This helps for example to rename or remove classes from the documentation. See https://bugzilla.yoctoproject.org/show_bug.cgi?id=14508 As this change is time consuming, submitting the first part of it as an RFC, to double check there is an agreement on doing this. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: updates for building on Windows (WSL 2)Michael Opdenacker2022-10-251-5/+5
| | | | | | | | | | | | | - Use the Wikipedia naming scheme: WSL 2 instead of WSLv2 - Take into account Windows Server 2019 and 2022 which are supported too. - Improve some explanations (From yocto-docs rev: 35c5fb01d3543ef5e1f4edf337a2ab080b4e7956) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>