aboutsummaryrefslogtreecommitdiffstats
AgeCommit message (Collapse)Author
40 hoursmanuals: remove tab characterskirkstoneMichael Opdenacker
As reported by "make sphinx-lint" Tabs are even removed in Makefile examples, as Sphinx turns them to spaces anyway in the generated output. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
40 hourskernel-dev: join mkdir commands with -pJörg Sommer
To make it more obvious which directories are needed, pass only these to *mkdir* and use the option `-p` to create the missing parents. Signed-off-by: Jörg Sommer <joerg.sommer@navimatix.de> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
40 hoursmanuals: fix incorrect double backticksMichael Opdenacker
As reported by "make sphinx-lint" Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
40 hoursmanuals: fix trailing spacesMichael Opdenacker
Fixing errors reported by "make sphinx-lint" Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
40 hoursmanuals: add initial sphinx-lint supportMichael Opdenacker
Makes it possible to catch errors not reported by sphinx, such as idle spaces. After customization, this should be used to enforce our syntax conventions, such as two spaces after a "-" character to introduce a list item. Just run "make sphinx-lint". Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
40 hoursmanuals: fix duplicate "stylecheck" targetMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
40 hoursmanuals: refer to new yocto-patches mailing list wherever appropriateQuentin Schulz
There's a new yocto-patches mailing list available for all layers that do not have their own mailing list. c.f. https://lists.yoctoproject.org/g/yocto/topic/105197684 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>
40 hoursdocs: conf.py: properly escape backslashes for latex_elementsQuentin Schulz
There are some syntax warnings returned by Python: """ yocto-docs/documentation/conf.py:162: SyntaxWarning: invalid escape sequence '\P' 'passoptionstopackages': '\PassOptionsToPackage{bookmarksdepth=5}{hyperref}', yocto-docs/documentation/conf.py:163: SyntaxWarning: invalid escape sequence '\s' 'preamble': '\setcounter{tocdepth}{2}', """ Backslashes must be doubled in Python string literals to avoid interpretation as escape sequence, c.f. https://www.sphinx-doc.org/en/master/latex.html#module-latex. 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>
40 hoursrelease-notes-4.0.17: reorder CVEsLee Chee Yang
reorder CVEs from alphabetical order to numerical order, align it with text based release notes. Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-03-25dev-manual: improve descriptions of 'bitbake -S printdiff'contrib/kirkstone-nextAlexander Kanavin
Try to particularly emphasize that it can be used to find out why something rebuilds when it shouldn't. Signed-off-by: Alexander Kanavin <alex@linutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-03-25ref-manual: add documentation of the variable SPDX_NAMESPACE_PREFIXBELOUARGA Mohamed
The documentation of the variable SPDX_NAMESPACE_PREFIX does not exist. This variable is used to change the prefix of some links in SPDX docs. Signed-off-by: BELOUARGA Mohamed <m.belouarga@technologyandstrategy.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-03-25profile-manual: usage.rst: further style improvementsMichael Opdenacker
According to errors reported by "make stylecheck" Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-03-25contributor-guide: be more specific about meta-* treesMartin Jansa
* this is often confused to apply for e.g. meta-oe as well where it doesn't apply as meta-oe has own ML mentioned in README. Signed-off-by: Martin Jansa <martin.jansa@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-03-25migration-guides: add release notes for 4.0.17Lee Chee Yang
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-03-25profile-manual: usage.rst: fix reference to bug reportMichael Opdenacker
Allowing to remove nested parentheses in the text! Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-03-25manuals: use "manual page(s)"Michael Opdenacker
Instead of "manpage(s)" or "man page(s)". To address one of the errors reported by "make stylecheck" Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-03-25profile-manual: usage.rst: formatting fixesMichael Opdenacker
Plus a few text styling improvements, some reported by "make stylecheck" Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-03-25manuals: add initial stylechecks with ValeMichael Opdenacker
Use the "Vale" (https://vale.sh) tool to perform text style checks Run "make stylecheck" to run the checks. This just checks the text, not the Sphinx syntax style choices. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Suggested-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2024-03-14manuals: document VIRTUAL-RUNTIME variablesMichael Opdenacker
Document the convention to use variables prefixed by VIRTUAL_RUNTIME. Add references to the new term where possible. Another reason is that such variables are recommended in a warning issued by meta/classes-global/insane.bbclass Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Tim Orling <ticotimo@gmail.com>
2024-03-14contributor-guide: add notes for testsSimone Weiß
This adds some hints that and how changes should be tested when contributing. Fixes [YOCTO #15412] Signed-off-by: Simone Weiß <simone.p.weiss@posteo.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-03-14manuals: replace hyphens with em dashesMichael Opdenacker
Fix some hyphens being improperly used as em dashes. See https://www.grammarly.com/blog/hyphens-and-dashes/ Using em dashes may also allow Sphinx to hyphenate and break lines in the best way. Note that the first character after an em dash not supposed to be capitalized, unless a specific rule applies, typically when what follows is a proper noun. Fix a few misuses of parentheses in following text. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-03-14dev-manual: packages: fix capitalizationMichael Opdenacker
Using "PR service" instead of "PR Service", like in the other two instances in this document. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Reviewed-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
2024-03-14ref-manual: variables: adding multiple groups in GROUPADD_PARAMGeoff Parker
Add missing documentation on how to add multiple groups with a single GROUPADD_PARAM:${PN} Signed-off-by: Geoff Parker <geoffrey.parker@arthrex.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-03-14ref-manual: variables: correct sdk installation default pathJohan Bezem
The SDKPATH variable seems mistakenly identified as the default path where the SDK will be installed by the generated installation script, unless option '-d' or a manual input overrides this default. The intended variable is SDKPATHINSTALL. SDKPATH indicates where the SDK is being composed and built. The definitions have been added/updated. Signed-off-by: Johan Bezem <jbezem.extern@arri.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-03-14ref-manual: tasks: do_cleansstate: recommend using '-f' instead for a shared ↵Luca Ceresoli
sstate do_cleansstat can produce build errors when using a shared sstate cache. Add a note to clearly discourage, provide a safe alternative (bitbake -f), and the rationale. Suggested-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Link: https://lore.kernel.org/yocto-docs/20240219155513.76738-1-luca.ceresoli@bootlin.com/T/#m5529687ecb0f9ec2dacddcb6ff58e2df73af9cde Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com> Reviewed-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
2024-03-14ref-manual: tasks: do_cleanall: recommend using '-f' insteadLuca Ceresoli
do_cleanall can produce failures when used in legitimate cases, such as with recipe variants (foo and foo-native) or a shared DL_DIR. This is why it is forbidden when writing tests that will run on the autobuilders (https://docs.yoctoproject.org/test-manual/intro.html?highlight=cleanall#considerations-when-writing-tests). Reword the documentation to clearly discourage, provide a safe alternative (bitbake -f -c fetch), and the rationale with an example. Reported-by: Sam Liddicott Link: https://bootlin.com/blog/yocto-sharing-the-sstate-cache-and-download-directories/#comment-2650335 Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com> Reviewed-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
2024-02-27ref-manual: system-requirements: remove outdated noteMichael Opdenacker
To align this document with the version in the master branch Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-02-27ref-manual: system-requirements.rst: fix AlmaLinux variable nameMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-02-27ref-manual: system-requirements: update packages to build docsMichael Opdenacker
- "git" is now required to run "set_versions.py" - Fix Ubuntu / Debian packages. The previous instructions didn't run on Debian 12 Tested on Ubuntu 22.04 and Debian 12. Reported on https://lists.yoctoproject.org/g/docs/message/4789 Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: <mhagans@skyviewsat.com>
2024-02-27ref-manual: system-requirements.rst: simplify supported distro requirementsMichael Opdenacker
- This allows to continue sharing the updated Ubuntu/Debian requirements with the brief-yoctoprojectqs/index.rst without indentation mismatches (caused by using the same macro in two different contexts: in direct text and in a bullet list). - Update poky.yaml.in to adapt the number of spaces at the beginning of lines. - brief-yoctoprojectqs/index.rst: fix bad number of spaces before quote block. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-02-27manuals: updates for building on Windows (WSL 2)Michael Opdenacker
- 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 Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss@0leil.net> --- Changes in V2: - Now using "Windows 10 or later, or Windows Server 2019 or later" as suggested by Quentin Schulz.
2024-02-27ref-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
2024-02-27ref-manual: system-requirements: modify anchorMichael Opdenacker
To align with the "master" branch Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-02-27manuals: update references to buildtoolsMichael Opdenacker
Also fix number of corresponding paragraphs Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-02-27ref-manual: add info on buildtools-make-tarballPaul Eggleton
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. Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
2024-02-27manuals: add minimum RAM requirementsMichael Opdenacker
Measured by generating a "core-image-sato" image for a "qemux86-64" machine from an Ubuntu 22.04 VM with 4 cores. Less memory was not enough and caused Out of Memory failures. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-02-27manuals: update disk space requirementsMichael Opdenacker
Tests made on Poky master on March 16, 2023. Add a "Free Disk Space" section to the "System Requirements" document. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-02-27dev-manual: packages: need enough free spaceMichael Opdenacker
Enough free storage space is needed to apply package upgrades. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-02-27dev-manual: packages: clarify shared PR service constraintMichael Opdenacker
Explicit the problems previous described as "obvious". Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Suggested-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-02-27manuals: suppress excess use of "following" wordMichael Opdenacker
To simplify the style, replace "Following is" and "Following are" by "here is" and "here are", sounding more natural. In some cases, also go further by simplifying "Here are/is xxx" by "xxx are/is" when the "are" or "is" are not two far at the end of the sentence. In some cases too, completely remove the sentence, when it's redundant with the preceding title. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> CC: Daniel Ammann <daniel.ammann@bytesatwork.ch> --- Changes in V2: - Further simplication of some "Here are" and "Here is" statements as suggested by Daniel Ammann <daniel.ammann@bytesatwork.ch> - Remove some sentences which were just repeating the preceding title.
2024-02-27ref-manual: release-process: grammar fixMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-02-27dev-manual: Rephrase spdx creationSimone Weiß
Make the options more clear by providing them in a list instead of plain prosa. Also add a ref for a presentation wrt spdx 3.0 in the Yocto project. Fixes [YOCTO 7476] Signed-off-by: Simone Weiß <simone.p.weiss@posteo.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-02-06dev-manual: start: remove idle lineMichael Opdenacker
Align with text in the other branches. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-02-06contributor-guide: fix lore URLBaruch Siach
Cc: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Baruch Siach <baruch@tkos.co.il> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-02-06dev-manual: gen-tapdevs need iptables installedSimone Weiß
Add the hint to the test setup that runqemu-gen-tapdevs will need the iptables package installed. Signed-off-by: Simone Weiß <simone.p.weiss@posteo.com>
2024-01-30migration-guide: add release notes for 4.0.16Lee Chee Yang
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-01-12documentation: Add UBOOT_BINARY, extend UBOOT_CONFIGyocto-4.0.16kirkstone-4.0.16Jörg Sommer
UBOOT_CONFIG accepts a third parameter for the UBOOT_BINARY that isn't documented. To show its usage another example from the meta-freescale layer was picked. Signed-off-by: Jörg Sommer <joerg.sommer@navimatix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-01-12manuals: document VSCode extensionEnguerrand de Ribaucourt
The VSCode extension is now officially maintained and published by the Yocto Project so it should be referenced in the manuals to help users discover it. I located the most relevant places to reference the extension by looking at how the old Eclipse plugin was documented in the 2.6 manuals as well as the current Toaster references. Signed-off-by: Enguerrand de Ribaucourt <enguerrand.de-ribaucourt@savoirfairelinux.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-01-12ref-manual: resources: sync with master branchMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-01-12ref-manual: classes: remove insserv bbclassMaxin B. John
insserv.bbclass was removed from oe-core: commit e6bb5dbb62257a7de730ea9085dfd89520f3e47d Author: Richard Purdie <richard.purdie@linuxfoundation.org> Date: Sun May 10 12:30:49 2015 +0100 insserv: Remove Signed-off-by: Maxin John <maxin.john@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
generated by cgit 1.2.3-korg (git 2.39.0) at 2024-04-16 10:18:23 +0000