linux/poky.git/documentation/kernel-dev, branch yocto-4.0.24

manuals: remove tab characters

2024-04-19T11:50:40+00:00

As reported by "make sphinx-lint" Tabs are even removed in Makefile examples, as Sphinx turns them to spaces anyway in the generated output. (From yocto-docs rev: fd1423141e7458ba557db465c171b0b4e9063987) Signed-off-by: Michael Opdenacker Reviewed-by: Quentin Schulz Signed-off-by: Steve Sakoman

kernel-dev: join mkdir commands with -p

2024-04-19T11:50:40+00:00

To make it more obvious which directories are needed, pass only these to *mkdir* and use the option `-p` to create the missing parents. (From yocto-docs rev: 4ddcedca4b09e2c051b33a40659ffce1db2984f5) Signed-off-by: Jörg Sommer Signed-off-by: Michael Opdenacker Signed-off-by: Steve Sakoman

manuals: replace hyphens with em dashes

2024-03-25T14:11:26+00:00

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: a0d93ea1ddfdfbcde8dac3aa328307be778f9e3c) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie Signed-off-by: Steve Sakoman

manuals: suppress excess use of "following" word

2024-03-01T15:19:54+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: 2539f1b9cbf9bdd40eff93c6522dc76133debed7) Signed-off-by: Michael Opdenacker CC: Daniel Ammann Signed-off-by: Steve Sakoman

manuals: correct "yocto-linux" by "linux-yocto"

2023-11-03T14:26:13+00:00

(From yocto-docs rev: 689f682c175e19664c090852d5c649280ce23fa0) Signed-off-by: Michael Opdenacker Signed-off-by: Steve Sakoman

manuals: update linux-yocto append examples

2023-10-25T14:45:51+00:00

(From yocto-docs rev: b5d385f20d22566e12a7938a9894b86429f1dcfb) Signed-off-by: Michael Opdenacker Signed-off-by: Steve Sakoman

manuals: update former references to dev-manual/common-tasks

2023-09-23T15:26:16+00:00

(From yocto-docs rev: f8bb4c392912f15bb78f6f25910f85897abb4e3d) Signed-off-by: Michael Opdenacker Signed-off-by: Steve Sakoman

docs: kernel-dev: faq: update tip on how to not include kernel in image

2023-01-06T17:33:45+00:00

Since commit f6d963fa6d0e ("kernel: make kernel-base recommend kernel-image, not depend"), present in Kirkstone 4.0, one should set RRECOMMENDS and not RDEPENDS to avoid including the kernel in the image, so let's update the documentation to reflect that. Reported-by: Konstantin Kletschke Cc: Quentin Schulz (From yocto-docs rev: b94956c7d416879f9e4c46102145ef478270c440) Signed-off-by: Quentin Schulz Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie

manuals: replace "rootfs" by "root filesystem"

2022-01-07T11:12:06+00:00

Almost everyone understands "rootfs", but "root filesystem" is real English. (From yocto-docs rev: 3d610f15e5b6be3435e9e81e4498a676671e5b39) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

make the documentation a bit more inclusive

2021-12-13T23:31:34+00:00

Except the name of variables which can't be changed only in the documentation for obvious reasons and workflow or developement explanations around the use of the "master" branch which cannot be replaced with "development" branch instead, most of the non-inclusive words that appear in https://inclusivenaming.org/word-lists/tier-1/ should have been replaced in this patch. (From yocto-docs rev: 2755f35060084f7af356091de9dc144f85530fe2) Signed-off-by: Quentin Schulz Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie