linux/poky.git/documentation/ref-manual/tasks.rst, branch scarthgap-5.0.13

sphinx-lint: unbalanced inline literal markup

2025-05-27T16:38:57+00:00

Fix as many instances of unbalanced-inline-literals-delimiters as reported by 'make sphinx-lint' as possible. Sphinx and/or its linter seem to get tripped up randomly when references contain links to heading which contain literals enclosed in double-back-tics, and not all of them can be "fixed" to pass both building and linting. (From yocto-docs rev: 0ba5429953dfa0cdc983ed13ddd06351116031c7) Signed-off-by: Trevor Woerner Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

ref-manual: move runtime-testing section to the test-manual

2025-01-09T14:25:36+00:00

In the same fashion as the previous commit ("ref-manual/packages: move ptest section to the test-manual"), move the runtime testing section of the development tasks manual to the test environment manual. Add a link to it from the test-manual/intro document. (From yocto-docs rev: 79aa34db34def525a11c41d951365bcb891318c4) Signed-off-by: Antonin Godard (cherry picked from commit 6b44257874858db3aa426d3e84a79c41cb4937a3) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

manuals: fix trailing spaces

2024-04-08T13:36:38+00:00

Fixing errors reported by "make sphinx-lint" (From yocto-docs rev: ef6b650c31c4320314564bb85a45eebde3fd98c1) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

ref-manual: tasks: do_cleansstate: recommend using '-f' instead for a shared sstate

2024-03-06T16:54:54+00:00

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 Link: https://lore.kernel.org/yocto-docs/20240219155513.76738-1-luca.ceresoli@bootlin.com/T/#m5529687ecb0f9ec2dacddcb6ff58e2df73af9cde (From yocto-docs rev: 6fb06bb4a917c1515e54fa3e699119f6bbb85767) Signed-off-by: Luca Ceresoli Reviewed-by: Quentin Schulz Signed-off-by: Richard Purdie

ref-manual: tasks: do_cleanall: recommend using '-f' instead

2024-03-06T16:54:54+00:00

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 (From yocto-docs rev: bfeb00f9213b9d2650ccf03ea666387415227be4) Signed-off-by: Luca Ceresoli Reviewed-by: Quentin Schulz Signed-off-by: Richard Purdie

ref-manual: Remove references to package_tar class

2023-04-22T09:42:54+00:00

This has been removed in 4.2. (From yocto-docs rev: a5dcaf95915deec5243ab2fd0711c63e98b2a661) Signed-off-by: Paul Eggleton Signed-off-by: Richard Purdie

manuals: simplify references to the BitBake User Manual

2023-03-20T13:16:52+00:00

- Replacing :ref:`bitbake:bitbake-user-manual/...` by :ref:`bitbake-user-manual/...` Adding "bitbake:" as a prefix is not necessary as there is no naming conflict between the YP and the BitBake manuals (all documents are in "bitbake-user-manual/") - Explaining the rules in the README file - When necessary, fixing line length in the modified paragraphs. (From yocto-docs rev: d80b31705450cfb98d217ea44ba2edace2d64095) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

manuals: simplify references to classes

2023-01-06T17:39:09+00:00

Now that .bbclass is removed from class section titles. We can now have, for example, :ref:`ref-classes-insane` instead of :ref:`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 Suggested-by: Quentin Schulz Signed-off-by: Richard Purdie

manuals: split dev-manual/common-tasks.rst

2022-12-01T19:20:29+00:00

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 Signed-off-by: Richard Purdie

Update documentation for classes split

2022-10-19T16:32:57+00:00

* Make reference to meta/classes* instead of just meta/classes * Update each reference to the path where the class has moved * Add a brief explanation to the classes reference explaining the split * Add a note to INHERIT, INHERIT_DISTRO, IMAGE_CLASSES and USER_CLASSES variable glossary entries mentioning where the specified classes must be located. I contemplated adding the same note to PACKAGE_CLASSES but decided against it, as it has a very specific usage and such a note might distract from the narrative of that entry. * Also trim the IMAGE_CLASSES entry which was quite outdated. * INHERIT += no longer works with testimage so drop the note about that (From yocto-docs rev: e76bed00b452d3049f6c22afbfb980b557a141bd) Signed-off-by: Paul Eggleton Signed-off-by: Richard Purdie