linux/poky.git/documentation/kernel-dev/intro.rst, branch scarthgap-5.0.15

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

manuals: define proper numbered lists

2022-12-18T10:41:21+00:00

Using "#." instead of "1.", "2.", "3.", etc. (From yocto-docs rev: 11c2585acd0fa6c330702af2359ce5a9e47cde1f) Signed-off-by: Michael Opdenacker Reported-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

manuals: use references to the "Build Directory" term

2022-10-28T14:48:03+00:00

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

kernel-dev: working with kernel using devtool does not require building and installing eSDK

2022-08-12T22:11:28+00:00

In fact, all the same tasks can be done directly from a Yocto build. Let's just drop the steps to produce and install the eSDK - if someone wants it, the SDK manual covers everything. (From yocto-docs rev: 582aa6a8e461bbd698b121403dcd25ddb563a464) Signed-off-by: Alexander Kanavin Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie

manuals: improve the width of diagrams

2022-05-10T11:52:35+00:00

Better for EPUB output in particular - Make some diagrams wider when necessary - Remove ":align: center" when we have ":width: 100%" - Update the standards.md files to mention this (From yocto-docs rev: 848ba7bd8984cc3f4bf6b818259865011cde0476) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

kernel-dev manual: simplify style

2021-05-22T11:16:40+00:00

(From yocto-docs rev: 5bbbed35175ffcabb24bcac305d17563b8d9b9e3) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

docs: replace anchor links

2021-04-09T14:24:46+00:00

Anchor links are treated by Sphinx as external links and are not checked during build, meaning it is impossible to know if a link becomes broken or not. As a matter of fact, most of the anchor links replaced in this commit were actually broken. The README now states that anchor links are forbidden so that there's no need to go through such a change later on. (From yocto-docs rev: de9e4d26b46afa3c79137d07529a74553400d2e0) Signed-off-by: Quentin Schulz Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie

documentation: Simplify oe_wiki and oe_home links

2020-12-24T08:23:33+00:00

(From yocto-docs rev: 6867f54f349edede37c4085194f51342c24297ed) Signed-off-by: Paul Barker Signed-off-by: Richard Purdie

sdk-manual: remove 'sdk' from filenames

2020-12-09T12:21:27+00:00

All filenames duplicate the 'manual name', which is not needed, and make all references longer than they should. Rename all files to be as consise as possible, and fix all references (From yocto-docs rev: bd8c0f7fc09a39a8bbde1c05b51693955738e148) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie