Commit Graph

9 Commits

Author SHA1 Message Date
Michael Opdenacker
8b812b29c4 manuals: add missing SPDX license header to source files
(From yocto-docs rev: 86737cc4583f1ef43bda10033c801329ba0c8b81)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-18 10:41:21 +00:00
Michael Opdenacker
f417d3274c manuals: add missing references to variables
[YOCTO #14508]
(From yocto-docs rev: 7878a21be8fb6c7a1ab88ae44aa5f7bf0079391a)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-18 10:41:21 +00:00
Michael Opdenacker
55621c31f1 manuals: add missing references to classes
Sometimes fixing line length in modified paragraphs too.

[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 885b60f5540849bf19240a01a77efce1d1b5d9f0)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-01 19:20:29 +00:00
Michael Opdenacker
40df2b19bd release-notes: use oe_git and yocto_git macros
As in the rest of the manuals; this is more future proof than using
hard coded URLs.

While doing this, also replacing https://git.yoctoproject.org/git/<repo>
links (used by mistake instead of https://git.yoctoproject.org/<repo>)
by :yocto_git:`/repo`.

(From yocto-docs rev: ac844062400a7bf4732ea6ee639a478b1b77b83e)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-11-10 22:12:56 +00:00
Michael Opdenacker
97495b4c89 manuals: add reference to the "do_populate_sdk" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 6d262b676ed1e8b6b404050dad20e85e7ceb28c2)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
9dbd27a48a manuals: improve initramfs details
- Create a new entry in the glossary
- Add implementation details
- Replace the mention of "init ramdisk" by "initramfs¨
  whenever possible
- Remove obsolete and duplicate information
- Fix spacing issues in the Sphinx code

(From yocto-docs rev: 952c7e6dee49532705b2c162f4728e635c38df3f)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:25 +01:00
Michael Opdenacker
d9adf28c10 manuals: replace hyphens with em dashes
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.

(From yocto-docs rev: 5918f019f63f6e820b1168f4cc001faa1d1cdc6f)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-06-27 14:55:08 +01:00
Michael Opdenacker
325c23cd0f manuals: fix quoting of double dashes
Otherwise rendered as "en" dashes by sphinx, for example:
git pull –rebase
instead of
git pull --rebase

Readers could confuse them with normal dashes.

Exception: replace by \-\- in italic text (*text*)
as Sphinx cannot nest italic and quoted text.

For consistency, also update quoting in strings in the same code hunks.

(From yocto-docs rev: 4e7ce372e37f76148f623a5295a15e08bc2603ff)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-31 11:46:03 +01:00
Michael Opdenacker
43fbe48298 documentation: individual release note files
This makes changes and new files easier to review

(From yocto-docs rev: f3f76236b5c003481a0f211b60a8df9479db833b)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-04 09:39:37 +00:00