linux/poky.git/documentation, branch yocto-4.0.18

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: fix incorrect double backticks

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

As reported by "make sphinx-lint" (From yocto-docs rev: 18d86626406fe07d4f62ef0b9168c0220b3dd90a) Signed-off-by: Michael Opdenacker Signed-off-by: Steve Sakoman

manuals: fix trailing spaces

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

Fixing errors reported by "make sphinx-lint" (From yocto-docs rev: 45b04c281a567e06fd2904166bcc26603e73e684) Signed-off-by: Michael Opdenacker Signed-off-by: Steve Sakoman

manuals: add initial sphinx-lint support

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

Makes it possible to catch errors not reported by sphinx, such as idle spaces. After customization, this should be used to enforce our syntax conventions, such as two spaces after a "-" character to introduce a list item. Just run "make sphinx-lint". (From yocto-docs rev: a735549a764f7cfebdc7534761b4d75dc523371a) Signed-off-by: Michael Opdenacker Signed-off-by: Steve Sakoman

manuals: fix duplicate "stylecheck" target

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

(From yocto-docs rev: 9247fd612db9e551eb58dbe41d31e460f0ad7d72) Signed-off-by: Michael Opdenacker Reviewed-by: Quentin Schulz Signed-off-by: Steve Sakoman

manuals: refer to new yocto-patches mailing list wherever appropriate

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

There's a new yocto-patches mailing list available for all layers that do not have their own mailing list. c.f. https://lists.yoctoproject.org/g/yocto/topic/105197684 Cc: Quentin Schulz (From yocto-docs rev: d7fc3e978440d9f5724cbce85de000317a3e0783) Signed-off-by: Quentin Schulz Reviewed-by: Michael Opdenacker Signed-off-by: Steve Sakoman

docs: conf.py: properly escape backslashes for latex_elements

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

There are some syntax warnings returned by Python: """ yocto-docs/documentation/conf.py:162: SyntaxWarning: invalid escape sequence '\P' 'passoptionstopackages': '\PassOptionsToPackage{bookmarksdepth=5}{hyperref}', yocto-docs/documentation/conf.py:163: SyntaxWarning: invalid escape sequence '\s' 'preamble': '\setcounter{tocdepth}{2}', """ Backslashes must be doubled in Python string literals to avoid interpretation as escape sequence, c.f. https://www.sphinx-doc.org/en/master/latex.html#module-latex. Cc: Quentin Schulz (From yocto-docs rev: 037f99339a4bae60f41f89df37911690b507c9a1) Signed-off-by: Quentin Schulz Reviewed-by: Michael Opdenacker Signed-off-by: Steve Sakoman

release-notes-4.0.17: reorder CVEs

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

reorder CVEs from alphabetical order to numerical order, align it with text based release notes. (From yocto-docs rev: a2ce17f656758db737c398263efa594604ca2271) Signed-off-by: Lee Chee Yang Reviewed-by: Michael Opdenacker Signed-off-by: Steve Sakoman

dev-manual: improve descriptions of 'bitbake -S printdiff'

2024-04-05T14:24:00+00:00

Try to particularly emphasize that it can be used to find out why something rebuilds when it shouldn't. (From yocto-docs rev: 1cd543e62e8f1b65e65108d919c2f481001e044c) Signed-off-by: Alexander Kanavin Reviewed-by: Michael Opdenacker Signed-off-by: Steve Sakoman