aboutsummaryrefslogtreecommitdiffstats
AgeCommit message (Collapse)Author
2023-02-13kernel-dev: harmonize example with ref-manualUlrich Ölmann
Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
2023-02-13ref-manual: refer to MACHINE variable instead of KMACHINEUlrich Ölmann
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> Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
2023-02-13kernel-dev,ref-manual: fix old override syntaxUlrich Ölmann
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> Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
2023-02-10ref-manual: document Rust classesMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> --- Changes in V2: - Grammar fix: replace "an src" by "a src" (Richard Purdie) - Document the cargo-update-recipe-crates class, thanks to information provided by Alex Kiernan
2023-02-10ref-manual: improve "devtool check-upgrade-status" explanationsMichael Opdenacker
- Fix broken link to a .bb file - Clarify the explanations Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-02-10bsp-guide: fix broken git URLs and missing wordMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-02-10manuals: replace unnecessary uses of 'yocto_docs' by internal referencesMichael Opdenacker
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. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-02-10profile-manual: update WireShark hyperlinksMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-02-09ref-manual: variables.rst: fix broken hyperlinkMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-02-08migration-guides: add release-notes for 4.0.7Lee Chee Yang
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Suggested-by: Takayasu Ito <ito@lineo.co.jp> --- Changes in V3: - Fix "underline too short" warnings - Fix broken links in CVEs, not existing in the NIST dababase because of a "RESERVED" state. Replaced by other links: - https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2022-43552 - https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2022-32891 - Also added: - python3: Fix :cve:`2022-45061` Reported by Takayasu Ito <ito@lineo.co.jp> Changes in V2: - V2 was sent by mistake with no changes
2023-02-07dev-manual: fix old override syntaxUlrich Ölmann
Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-02-01ref-manual: variables: FIT_KERNEL_COMP_ALG: add lzoRichard Leitner
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. Signed-off-by: Richard Leitner <dev@g0hl1n.net> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-01-26migration-guides/migration-4.2.rst: fix minor issuesMichael Opdenacker
- Underline fix - Spacing fixes in bullet lists. Our standard is to use two spaces after "-", and a bullet list is supposed to be preceded by an empty line to be recognized. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-01-19migration-guides: add release-notes for 4.1.2Lee Chee Yang
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-01-18manuals: fix typo in the MLPREFIX descriptionLuca Ceresoli
Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-01-11ref-manual: initial documentation for go and go-mod classesMichael Opdenacker
This addresses [YOCTO #14582] --- If you are familiar with the Go classes, please review and propose corrections or extensions to what I wrote. My understanding of Go is very limited, and I'm not even sure go-mod.bbclass is for building or just importing Go modules. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Jan Dorniak <jaskij@gmail.com>
2023-01-06ref-manual/system-requirements.rst: recommend buildtools for not supported ↵Michael Opdenacker
distros Also minor correction to supported distribution notes Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Suggested-by: Alexander Kanavin <alex.kanavin@gmail.com> --- Changes in V2: - Add reference to the section explaining how to get buildtools
2023-01-06migration-1.6.rst: fix redundant referenceMichael Opdenacker
Fix sentence containing two references to the same section. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-01-06manuals: simplify references to classesMichael Opdenacker
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. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Suggested-by: Quentin Schulz <foss+yocto@0leil.net>
2023-01-06ref-manual/classes.rst: remove .bbclass from section titlesMichael Opdenacker
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>`. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Suggested-by: Quentin Schulz <foss+yocto@0leil.net>
2023-01-05docs: migration-guides: migration-4.0: specify variable name change for ↵Quentin Schulz
kernel inclusion in image recipe Since commit f6d963fa6d0e ("kernel: make kernel-base recommend kernel-image, not depend"), present in Kirkstone 4.0, one should set RRECOMMENDS and not RDEPENDS to avoid including the kernel in the image, so let's update the documentation to reflect that. Reported-by: Konstantin Kletschke <konstantin.kletschke@inside-m2m.de> Cc: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-01-05docs: kernel-dev: faq: update tip on how to not include kernel in imageQuentin Schulz
Since commit f6d963fa6d0e ("kernel: make kernel-base recommend kernel-image, not depend"), present in Kirkstone 4.0, one should set RRECOMMENDS and not RDEPENDS to avoid including the kernel in the image, so let's update the documentation to reflect that. Reported-by: Konstantin Kletschke <konstantin.kletschke@inside-m2m.de> Cc: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-01-04toaster-manual: fix description of introduction videoMichael Opdenacker
The video referred to didn't correspond to the latest Poky releases. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-01-03migration-guides: add release-notes for 4.0.6Lee Chee Yang
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> --- Changes in V2: - Add missing SPDX header at the beginning of the file - Add fixed vim CVEs (reported by Takayasu Ito)
2023-01-02migration-guides: fix 4.2 migration note issuesMichael Opdenacker
- Eliminate this warning: WARNING: Title underline too short. - Remove a leftover patch file Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2022-12-16manuals: prepare 4.2 migration notesMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2022-12-16documentation/poky.yaml.in: update minimum python version to 3.8Michael Opdenacker
Now required by Bitbake: https://git.openembedded.org/bitbake/commit/?id=744310f360d2288ac2ef07745abc86852126b5b9 Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2022-12-16manuals: create references to buildtoolsMichael Opdenacker
On the side, also simplify a reference to the section describing them. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2022-12-16ref-manual/system-requirements.rst: update buildtools instructionsMichael Opdenacker
- Stop mentioning the buildtools i586 environment setup file, no longer available. - Remove trivial or redundant instructions. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2022-12-14ref-manual/resources.rst: improve description of mailing listsMichael Opdenacker
- Mention docs@lists.yoctoproject.org - Refer to the specific web page about all mailing lists, instead of just the website home page. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
2022-12-14manuals: final removal of SERIAL_CONSOLE variableMichael Opdenacker
This deprecated variable has been removed for good through https://git.openembedded.org/openembedded-core/commit/?id=9d053af1fb570b4e3483de4ecd6827e1e0be61b7 Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2022-12-09manuals: define proper numbered listsMichael Opdenacker
Using "#." instead of "1.", "2.", "3.", etc. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Quentin Schulz <foss+yocto@0leil.net>
2022-12-09ref-manual/images.rst: fix unnumbered listMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
2022-12-09manual: improve documentation about using external toolchainsMichael Opdenacker
- 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. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2022-12-09ref-manual: update references to release notesMichael Opdenacker
Now part of the Yocto Project manual. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2022-12-09ref-manual/resources.rst: fix formatingMichael Opdenacker
Simplify formating for better looking output. For example, mosts paragraphs had only ther ":" character in boldface. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2022-12-09manuals: fix double colonsMichael Opdenacker
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. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> --- Note: instances to replace detected by the following command: git grep "^\s*\:\:\s*$"
2022-12-08manuals: add missing SPDX license header to source filesMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2022-12-08manuals: add missing references to variablesMichael Opdenacker
[YOCTO #14508] Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> --- Missing references detected by: - Listing all variables in the YP manual: grep "^ :term:" documentation/ref-manual/variables.rst | sed -n -e 's/^\(.*\)\(:term:`\)\(.*\)\(`\)/\3/p' > /tmp/yocto-vars.txt - Then grepping each variable in the manuals, either in the middle of a line, or at the beginning or at the end: cat /tmp/yocto-vars.txt | while read var; do echo $var; git grep " $var " *.rst | grep -v " = "; done > /tmp/unreferrenced-vars1.txt cat /tmp/yocto-vars.txt | while read var; do echo $var; git grep " $var$" *.rst | grep -v " = "; done > /tmp/unreferrenced-vars2.txt cat /tmp/yocto-vars.txt | while read var; do echo $var; git grep "^$var " *.rst | grep -v " = "; done > /tmp/unreferrenced-vars3.txt Then inspecting the 3 results files and fixing the true positives manually. There were many false positives too, but this reduced the number of lines to inspect.
2022-12-06manuals: add reference to yocto-docs git repository to page footerMichael Opdenacker
To make documentation sources easier to find. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2022-12-02ref-manual: add references to variables only documented in the BitBake manualMichael Opdenacker
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. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
2022-12-01dev-manual/runtime-testing.rst: fix oeqa runtime test pathMikko Rapeli
It's "runtime/cases" in master and kirkstone. If layer specific tests are in "runtime" directory, they will not be found. Signed-off-by: Mikko Rapeli <mikko.rapeli@linaro.org> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2022-11-25dev-manual/sbom.rst: minor correctionsMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2022-11-25manuals: split dev-manual/common-tasks.rstMichael Opdenacker
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. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2022-11-25migration-guides: add release-notes for 4.1.1Chee Yang Lee
Signed-off-by: Chee Yang Lee <chee.yang.lee@intel.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2022-11-24manuals: simplify .gitignore filesMichael Opdenacker
Remove obsolete and unnecessary ignores. Just found one .pyc file in documentation/sphinx/__pycache__, so ignored that directory. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2022-11-22ref-manual/classes.rst: remove reference to sip.bbclassMichael Opdenacker
Removed in version 2.2 Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2022-11-22manuals: fix paragraphs with the "inherit" wordMichael Opdenacker
Nothing wrong with this word, but instances of "inherit" were looked for while looking for class names without references. Fixing alignment and sometimes syntax. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2022-11-22manuals: add missing references to classesMichael Opdenacker
Sometimes fixing line length in modified paragraphs too. [YOCTO #14508] Reported-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2022-11-21qemu.rst: slirp port forwarding detailsAtanas Bunchev
Explain the default behavior of `runqemu slirp`. Explain how to forward ports from the guest to the host machine. 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>
generated by cgit 1.2.3-korg (git 2.39.0) at 2024-06-12 21:09:55 +0000