linux/poky.git/documentation/dev-manual/debugging.rst, branch scarthgap-5.0.15

dev-manual: debugging: use bitbake-getvar in Viewing Variable Values section

2025-11-26T15:50:36+00:00

We should recommend using bitbake-getvar command wherever possible as its output is much less confusing and overwhelming than bitbake -e. Unfortunately, bitbake-getvar currently doesn't list Python tasks or functions, unlike bitbake -e, so keep the latter for some corner cases. [AG: Moroever -> Moreover typo fix] (From yocto-docs rev: 3f1ca1c3ef60dfabe5b2a2c6e53d14edad64fb06) Signed-off-by: Quentin Schulz Signed-off-by: Antonin Godard (cherry picked from commit 41e4e05369c4e028c679749b7b62434327927a09) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

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

dev-manual/debugging: mention new ``taskexp_ncurses`` option

2024-04-12T16:29:34+00:00

(From yocto-docs rev: 301c802a92a2c53c3d0c755c31a6e09130956fde) Signed-off-by: Michael Opdenacker Suggested_by: Reyna, David Signed-off-by: Richard Purdie

dev-manual: improve descriptions of 'bitbake -S printdiff'

2024-03-19T15:22:27+00:00

Try to particularly emphasize that it can be used to find out why something rebuilds when it shouldn't. (From yocto-docs rev: cfaf2707b4a77888316d5eb24bf41ccc21e2c12b) Signed-off-by: Alexander Kanavin Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie

manuals: suppress excess use of "following" word

2024-02-24T16:13:28+00:00

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. (From yocto-docs rev: 52ba6bb16c73cbc2c0e77496d5226c49bce786f5) Signed-off-by: Michael Opdenacker CC: Daniel Ammann Signed-off-by: Richard Purdie

manuals: document minidebuginfo

2023-12-18T13:18:55+00:00

(From yocto-docs rev: 1a6327f2d92b390248afb45119d79bb05cda3dcc) Signed-off-by: Etienne Cordonnier Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie

dev-manual: Discourage the use of SRC_URI[md5sum]

2023-12-18T13:18:55+00:00

SRC_URI[md5sum] has been deprecated for a long time. Discourage its use by removing it from examples and note that it should be replaced by SRC_URI[sha256sum] when updating recipes. Also mention that bitbake supports other checksums, though they are not commonly used. (From yocto-docs rev: 806c6cb0b457248ac7401487ba2cdd17a1eba320) Signed-off-by: Peter Kjellerstedt Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie

contributor guide: update instructions for making and sharing changes

2023-08-30T14:54:59+00:00

- Shifting the focus to multiple changes instead of just one - Advising to create a branch for changes - Removing unnecessary or too verbose explanations - Adding useful resources and examples (From yocto-docs rev: e7e47121fd979e034f8f40a043912640a6a25a5e) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

contributor guide: call section "Reporting a defect"

2023-08-30T14:54:59+00:00

Instead of "Submitting a defect". We all write bugs, and nobody needs documentation support for doing so! (From yocto-docs rev: ce94f6ed029afc8c69e84354c03bd0a9ab14f867) Signed-off-by: Michael Opdenacker Reported-by: Joshua Watt Signed-off-by: Richard Purdie

manuals: create a dedicated "Contributor Guide" document

2023-08-30T14:54:59+00:00

Starting from the original contents of dev-manual/changes.rst and from text contributed by Richard Purdie. (From yocto-docs rev: 55587d9dd009cbc92273376e0f7665b2d574d280) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie