linux/poky.git/documentation/kernel-dev/common.rst, branch yocto-5.1.4

Update the documentation for SRCPV

2024-12-26T14:01:37+00:00

The variable SRCPV is deprecated since 4.3. Instead of including SRCPV in PV, including the sign "+" is enough for bitbake to add the source control information to PKGV during the packaging phase. Update the documentation for SRCPV and the places where it was used. When instructions previously referred to SRCPV, replace by mentioning to include "+" in the assignment. In most examples, "+git" is added to PV as it is the most popular SCM. Simply adding "+" is also possible, although it is better practice to include the SCM name, so give that example. Update the gcompat example with l3afpad as it didn't include "+git" in its PV definition anymore. (From yocto-docs rev: 3866c09cc0460d25fefc0c831affd89633cf8a7b) Signed-off-by: Antonin Godard (cherry picked from commit ee16c96202e5027d1a8d7e89e11c25f127c78326) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

manuals: remove tab characters

2024-04-12T16:29:34+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: 20e9c0c9fad3109567948af6bc40bb0fa2a5552b) Signed-off-by: Michael Opdenacker Reviewed-by: Quentin Schulz Signed-off-by: Richard Purdie

kernel-dev: join mkdir commands with -p

2024-04-08T13:36:38+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: 92806d2ab1f909eef9ccc532958a7ced6262b9b0) Signed-off-by: Jörg Sommer Signed-off-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: correct "yocto-linux" by "linux-yocto"

2023-10-30T11:11:16+00:00

(From yocto-docs rev: 1fc5046100f27126711df0513d1ad87a9a54f55a) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

manuals: update linux-yocto append examples

2023-10-20T13:40:29+00:00

(From yocto-docs rev: 0d195d66e434ddedd33bf8db89643fa5ab192e29) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

kernel-dev: fix typos

2023-04-03T13:48:47+00:00

(From yocto-docs rev: 79aa7b7bf1690267b1e7900fdf10165be5b460af) Signed-off-by: Ulrich Ölmann Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie

kernel-dev: harmonize example with ref-manual

2023-02-24T15:43:24+00:00

(From yocto-docs rev: 02e8a7e25eda462a5e244bd2bfb557554c1155fb) Signed-off-by: Ulrich Ölmann Reviewed-by: Quentin Schulz Signed-off-by: Richard Purdie

kernel-dev,ref-manual: fix old override syntax

2023-02-24T15:43:24+00:00

Additionally use more common syntax to indicate that an actual machine name is supposed to be filled in for a concrete use case as has been suggested by Peter Kjellerstedt (and particularly no KMACHINE). Furthermore add missing quotes in the reference manual. Suggested-by: Peter Kjellerstedt (From yocto-docs rev: b66c035970f860b65cf712285f2d5a023620e6c3) Signed-off-by: Ulrich Ölmann Reviewed-by: Quentin Schulz 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