linux/poky.git/documentation/sdk-manual, branch mickledore-4.2.3

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: 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: fix double colons

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

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. (From yocto-docs rev: fb054622f5119444eb947fe580253f37e0d872c6) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

manuals: add missing references to variables

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

[YOCTO #14508] (From yocto-docs rev: 7878a21be8fb6c7a1ab88ae44aa5f7bf0079391a) Signed-off-by: Michael Opdenacker 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: fix paragraphs with the "inherit" word

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

Nothing wrong with this word, but instances of "inherit" were looked for while looking for class names without references. Fixing alignment and sometimes syntax. (From yocto-docs rev: c418c645a360e74ebb91765a3041336f03097e0d) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

manuals: add shortcut for Wikipedia links

2022-11-07T21:31:32+00:00

(From yocto-docs rev: 47101c15cce156ab71683cac1c42ab94f43bdbee) 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

manuals: add missing references to SDKMACHINE and SDK_ARCH

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

Doing this, fix the odd identation of the corresponding paragraphs (From yocto-docs rev: e319b3bf4eb6420949372e699d60c7383945e513) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie