* [kirkstone][PATCH 0/9] documentation backports
@ 2024-04-14 18:20 michael.opdenacker
2024-04-14 18:20 ` [kirkstone][PATCH 1/9] release-notes-4.0.17: reorder CVEs michael.opdenacker
` (8 more replies)
0 siblings, 9 replies; 10+ messages in thread
From: michael.opdenacker @ 2024-04-14 18:20 UTC (permalink / raw)
To: docs; +Cc: Michael Opdenacker
From: Michael Opdenacker <michael.opdenacker@bootlin.com>
Picking changes from the "master" branch when applicable.
Jörg Sommer (1):
kernel-dev: join mkdir commands with -p
Lee Chee Yang (1):
release-notes-4.0.17: reorder CVEs
Michael Opdenacker (5):
manuals: fix duplicate "stylecheck" target
manuals: add initial sphinx-lint support
manuals: fix trailing spaces
manuals: fix incorrect double backticks
manuals: remove tab characters
Quentin Schulz (2):
docs: conf.py: properly escape backslashes for latex_elements
manuals: refer to new yocto-patches mailing list wherever appropriate
documentation/Makefile | 5 +-
documentation/README | 14 +++
documentation/conf.py | 4 +-
.../contributor-guide/submit-changes.rst | 2 +-
documentation/dev-manual/init-manager.rst | 2 +-
documentation/dev-manual/layers.rst | 16 +--
documentation/dev-manual/start.rst | 12 +-
documentation/dev-manual/wic.rst | 56 ++++-----
documentation/kernel-dev/advanced.rst | 4 +-
documentation/kernel-dev/common.rst | 14 +--
.../migration-guides/migration-4.0.rst | 20 +--
.../migration-guides/release-notes-4.0.17.rst | 12 +-
.../migration-guides/release-notes-4.0.5.rst | 2 +-
.../migration-guides/release-notes-4.0.rst | 17 ++-
documentation/overview-manual/intro.rst | 2 +-
documentation/profile-manual/usage.rst | 116 +++++++++---------
documentation/ref-manual/classes.rst | 2 +-
documentation/ref-manual/resources.rst | 3 +
documentation/ref-manual/tasks.rst | 2 +-
documentation/ref-manual/terms.rst | 10 +-
documentation/ref-manual/variables.rst | 2 +-
documentation/sdk-manual/working-projects.rst | 10 +-
22 files changed, 170 insertions(+), 157 deletions(-)
--
2.34.1
^ permalink raw reply [flat|nested] 10+ messages in thread
* [kirkstone][PATCH 1/9] release-notes-4.0.17: reorder CVEs
2024-04-14 18:20 [kirkstone][PATCH 0/9] documentation backports michael.opdenacker
@ 2024-04-14 18:20 ` michael.opdenacker
2024-04-14 18:20 ` [kirkstone][PATCH 2/9] docs: conf.py: properly escape backslashes for latex_elements michael.opdenacker
` (7 subsequent siblings)
8 siblings, 0 replies; 10+ messages in thread
From: michael.opdenacker @ 2024-04-14 18:20 UTC (permalink / raw)
To: docs; +Cc: Michael Opdenacker, Lee Chee Yang
From: Michael Opdenacker <michael.opdenacker@bootlin.com>
From: Lee Chee Yang <chee.yang.lee@intel.com>
reorder CVEs from alphabetical order to numerical order, align it
with text based release notes.
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
.../migration-guides/release-notes-4.0.17.rst | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/documentation/migration-guides/release-notes-4.0.17.rst b/documentation/migration-guides/release-notes-4.0.17.rst
index 1dfd10ce20..07242584b8 100644
--- a/documentation/migration-guides/release-notes-4.0.17.rst
+++ b/documentation/migration-guides/release-notes-4.0.17.rst
@@ -6,7 +6,7 @@ Release notes for Yocto-4.0.17 (Kirkstone)
Security Fixes in Yocto-4.0.17
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- bind: Fix :cve:`2023-4408`, :cve:`2023-50387`, :cve:`2023-50868`, :cve:`2023-5517` and :cve:`2023-5679`
+- bind: Fix :cve:`2023-4408`, :cve:`2023-5517`, :cve:`2023-5679`, :cve:`2023-50868` and :cve:`2023-50387`
- binutils: Fix :cve:`2023-39129` and :cve:`2023-39130`
- curl: Fix :cve:`2023-46219`
- curl: Ignore :cve:`2023-42915`
@@ -18,13 +18,13 @@ Security Fixes in Yocto-4.0.17
- libgit2: Fix :cve:`2024-24575` and :cve:`2024-24577`
- libuv: fix :cve:`2024-24806`
- libxml2: Fix for :cve:`2024-25062`
-- linux-yocto/5.15: Fix :cve:`2022-36402`, :cve:`2022-40982`, :cve:`2022-47940`, :cve:`2023-1193`, :cve:`2023-1194`, :cve:`2023-20569`, :cve:`2023-20588`, :cve:`2023-25775`, :cve:`2023-31085`, :cve:`2023-32247`, :cve:`2023-32250`, :cve:`2023-32252`, :cve:`2023-32254`, :cve:`2023-32257`, :cve:`2023-32258`, :cve:`2023-34324`, :cve:`2023-35827`, :cve:`2023-3772`, :cve:`2023-38427`, :cve:`2023-38430`, :cve:`2023-38431`, :cve_mitre:`2023-3867`, :cve:`2023-39189`, :cve:`2023-39192`, :cve:`2023-39193`, :cve:`2023-39194`, :cve:`2023-39198`, :cve:`2023-40283`, :cve:`2023-4128`, :cve:`2023-4206`, :cve:`2023-4207`, :cve:`2023-4208`, :cve:`2023-4244`, :cve:`2023-4273`, :cve:`2023-42752`, :cve:`2023-42753`, :cve:`2023-42754`, :cve:`2023-42755`, :cve:`2023-4563`, :cve:`2023-4569`, :cve:`2023-45871`, :cve:`2023-4623`, :cve:`2023-46343`, :cve:`2023-46813`, :cve:`2023-46838`, :cve:`2023-46862`, :cve:`2023-4881`, :cve:`2023-4921`, :cve:`2023-51042`, :cve:`2023-5158`, :cve:`2023-51779`, :cve_mitre:`2023-52340`, :cve:`2023-52429`, :cve:`2023-52435`, :cve:`2023-52436`, :cve:`2023-52438`, :cve:`2023-52439`, :cve:`2023-52441`, :cve:`2023-52442`, :cve:`2023-52443`, :cve:`2023-52444`, :cve:`2023-52445`, :cve:`2023-52448`, :cve:`2023-52449`, :cve:`2023-52451`, :cve:`2023-52454`, :cve:`2023-52456`, :cve:`2023-52457`, :cve:`2023-52458`, :cve:`2023-52463`, :cve:`2023-52464`, :cve:`2023-5717`, :cve:`2023-6040`, :cve:`2023-6121`, :cve:`2023-6176`, :cve:`2023-6546`, :cve:`2023-6606`, :cve:`2023-6622`, :cve:`2023-6817`, :cve:`2023-6915`, :cve:`2023-6931`, :cve:`2023-6932`, :cve:`2024-0340`, :cve:`2024-0584`, :cve:`2024-0607`, :cve:`2024-0641`, :cve:`2024-0646`, :cve:`2024-1085`, :cve:`2024-1086`, :cve:`2024-1151`, :cve:`2024-22705`, :cve:`2024-23849`, :cve:`2024-23850`, :cve:`2024-23851`, :cve:`2024-24860`, :cve:`2024-26586`, :cve:`2024-26589`, :cve:`2024-26591`, :cve:`2024-26592`, :cve:`2024-26593`, :cve:`2024-26594`, :cve:`2024-26597` and :cve:`2024-26598`
-- linux-yocto/5.15: Ignore :cve:`2020-27418`, :cve:`2020-36766`, :cve:`2021-33630`, :cve:`2021-33631`, :cve:`2022-48619`, :cve:`2023-2430`, :cve:`2023-40791`, :cve:`2023-42756`, :cve:`2023-44466`, :cve:`2023-45862`, :cve:`2023-45863`, :cve:`2023-45898`, :cve:`2023-4610`, :cve:`2023-4732`, :cve:`2023-5090`, :cve:`2023-51043`, :cve:`2023-5178`, :cve:`2023-51780`, :cve:`2023-51781`, :cve:`2023-51782`, :cve:`2023-5197`, :cve:`2023-52433`, :cve:`2023-52440`, :cve:`2023-52446`, :cve:`2023-52450`, :cve:`2023-52453`, :cve:`2023-52455`, :cve:`2023-52459`, :cve:`2023-52460`, :cve:`2023-52461`, :cve:`2023-52462`, :cve:`2023-5345`, :cve:`2023-5633`, :cve:`2023-5972`, :cve:`2023-6111`, :cve:`2023-6200`, :cve:`2023-6531`, :cve:`2023-6679`, :cve:`2023-7192`, :cve:`2024-0193`, :cve:`2024-0443`, :cve:`2024-0562`, :cve:`2024-0582`, :cve:`2024-0639`, :cve:`2024-0775`, :cve:`2024-26581`, :cve:`2024-26582`, :cve:`2024-26590`, :cve:`2024-26596` and :cve:`2024-26599`
-- linux-yocto/5.10: Fix :cve:`2023-39198`, :cve:`2023-46838`, :cve:`2023-51779`, :cve:`2023-51780`, :cve:`2023-51781`, :cve:`2023-51782`, :cve_mitre:`2023-52340`, :cve:`2023-6040`, :cve:`2023-6121`, :cve:`2023-6606`, :cve:`2023-6817`, :cve:`2023-6915`, :cve:`2023-6931`, :cve:`2023-6932`, :cve:`2024-0584` and :cve:`2024-0646`
-- linux-yocto/5.10: Ignore :cve:`2021-33630`, :cve:`2021-33631`, :cve:`2022-1508`, :cve:`2022-36402`, :cve:`2022-48619`, :cve:`2023-2430`, :cve:`2023-4610`, :cve:`2023-46343`, :cve:`2023-51042`, :cve:`2023-51043`, :cve:`2023-5972`, :cve:`2023-6039`, :cve:`2023-6200`, :cve:`2023-6531`, :cve:`2023-6546`, :cve:`2023-6622`, :cve:`2023-6679`, :cve:`2023-7192`, :cve:`2024-0193`, :cve:`2024-0443`, :cve:`2024-0562`, :cve:`2024-0582`, :cve:`2024-0639`, :cve:`2024-0641`, :cve:`2024-0775`, :cve:`2024-1085` and :cve:`2024-22705`
+- linux-yocto/5.15: Fix :cve:`2022-36402`, :cve:`2022-40982`, :cve:`2022-47940`, :cve:`2023-1193`, :cve:`2023-1194`, :cve:`2023-3772`, :cve_mitre:`2023-3867`, :cve:`2023-4128`, :cve:`2023-4206`, :cve:`2023-4207`, :cve:`2023-4208`, :cve:`2023-4244`, :cve:`2023-4273`, :cve:`2023-4563`, :cve:`2023-4569`, :cve:`2023-4623`, :cve:`2023-4881`, :cve:`2023-4921`, :cve:`2023-5158`, :cve:`2023-5717`, :cve:`2023-6040`, :cve:`2023-6121`, :cve:`2023-6176`, :cve:`2023-6546`, :cve:`2023-6606`, :cve:`2023-6622`, :cve:`2023-6817`, :cve:`2023-6915`, :cve:`2023-6931`, :cve:`2023-6932`, :cve:`2023-20569`, :cve:`2023-20588`, :cve:`2023-25775`, :cve:`2023-31085`, :cve:`2023-32247`, :cve:`2023-32250`, :cve:`2023-32252`, :cve:`2023-32254`, :cve:`2023-32257`, :cve:`2023-32258`, :cve:`2023-34324`, :cve:`2023-35827`, :cve:`2023-38427`, :cve:`2023-38430`, :cve:`2023-38431`, :cve:`2023-39189`, :cve:`2023-39192`, :cve:`2023-39193`, :cve:`2023-39194`, :cve:`2023-39198`, :cve:`2023-40283`, :cve:`2023-42752`, :cve:`2023-42753`, :cve:`2023-42754`, :cve:`2023-42755`, :cve:`2023-45871`, :cve:`2023-46343`, :cve:`2023-46813`, :cve:`2023-46838`, :cve:`2023-46862`, :cve:`2023-51042`, :cve:`2023-51779`, :cve_mitre:`2023-52340`, :cve:`2023-52429`, :cve:`2023-52435`, :cve:`2023-52436`, :cve:`2023-52438`, :cve:`2023-52439`, :cve:`2023-52441`, :cve:`2023-52442`, :cve:`2023-52443`, :cve:`2023-52444`, :cve:`2023-52445`, :cve:`2023-52448`, :cve:`2023-52449`, :cve:`2023-52451`, :cve:`2023-52454`, :cve:`2023-52456`, :cve:`2023-52457`, :cve:`2023-52458`, :cve:`2023-52463`, :cve:`2023-52464`, :cve:`2024-0340`, :cve:`2024-0584`, :cve:`2024-0607`, :cve:`2024-0641`, :cve:`2024-0646`, :cve:`2024-1085`, :cve:`2024-1086`, :cve:`2024-1151`, :cve:`2024-22705`, :cve:`2024-23849`, :cve:`2024-23850`, :cve:`2024-23851`, :cve:`2024-24860`, :cve:`2024-26586`, :cve:`2024-26589`, :cve:`2024-26591`, :cve:`2024-26592`, :cve:`2024-26593`, :cve:`2024-26594`, :cve:`2024-26597` and :cve:`2024-26598`
+- linux-yocto/5.15: Ignore :cve:`2020-27418`, :cve:`2020-36766`, :cve:`2021-33630`, :cve:`2021-33631`, :cve:`2022-48619`, :cve:`2023-2430`, :cve:`2023-4610`, :cve:`2023-4732`, :cve:`2023-5090`, :cve:`2023-5178`, :cve:`2023-5197`, :cve:`2023-5345`, :cve:`2023-5633`, :cve:`2023-5972`, :cve:`2023-6111`, :cve:`2023-6200`, :cve:`2023-6531`, :cve:`2023-6679`, :cve:`2023-7192`, :cve:`2023-40791`, :cve:`2023-42756`, :cve:`2023-44466`, :cve:`2023-45862`, :cve:`2023-45863`, :cve:`2023-45898`, :cve:`2023-51043`, :cve:`2023-51780`, :cve:`2023-51781`, :cve:`2023-51782`, :cve:`2023-52433`, :cve:`2023-52440`, :cve:`2023-52446`, :cve:`2023-52450`, :cve:`2023-52453`, :cve:`2023-52455`, :cve:`2023-52459`, :cve:`2023-52460`, :cve:`2023-52461`, :cve:`2023-52462`, :cve:`2024-0193`, :cve:`2024-0443`, :cve:`2024-0562`, :cve:`2024-0582`, :cve:`2024-0639`, :cve:`2024-0775`, :cve:`2024-26581`, :cve:`2024-26582`, :cve:`2024-26590`, :cve:`2024-26596` and :cve:`2024-26599`
+- linux-yocto/5.10: Fix :cve:`2023-6040`, :cve:`2023-6121`, :cve:`2023-6606`, :cve:`2023-6817`, :cve:`2023-6915`, :cve:`2023-6931`, :cve:`2023-6932`, :cve:`2023-39198`, :cve:`2023-46838`, :cve:`2023-51779`, :cve:`2023-51780`, :cve:`2023-51781`, :cve:`2023-51782`, :cve_mitre:`2023-52340`, :cve:`2024-0584` and :cve:`2024-0646`
+- linux-yocto/5.10: Ignore :cve:`2021-33630`, :cve:`2021-33631`, :cve:`2022-1508`, :cve:`2022-36402`, :cve:`2022-48619`, :cve:`2023-2430`, :cve:`2023-4610`, :cve:`2023-5972`, :cve:`2023-6039`, :cve:`2023-6200`, :cve:`2023-6531`, :cve:`2023-6546`, :cve:`2023-6622`, :cve:`2023-6679`, :cve:`2023-7192`, :cve:`2023-46343`, :cve:`2023-51042`, :cve:`2023-51043`, :cve:`2024-0193`, :cve:`2024-0443`, :cve:`2024-0562`, :cve:`2024-0582`, :cve:`2024-0639`, :cve:`2024-0641`, :cve:`2024-0775`, :cve:`2024-1085` and :cve:`2024-22705`
- openssl: Fix :cve:`2024-0727`
- python3-pycryptodome: Fix :cve:`2023-52323`
-- qemu: Fix :cve:`2023-42467`, :cve:`2023-6693` and :cve:`2024-24474`
+- qemu: Fix :cve:`2023-6693`, :cve:`2023-42467` and :cve:`2024-24474`
- vim: Fix :cve:`2024-22667`
- xwayland: Fix :cve:`2023-6377` and :cve:`2023-6478`
--
2.34.1
^ permalink raw reply related [flat|nested] 10+ messages in thread
* [kirkstone][PATCH 2/9] docs: conf.py: properly escape backslashes for latex_elements
2024-04-14 18:20 [kirkstone][PATCH 0/9] documentation backports michael.opdenacker
2024-04-14 18:20 ` [kirkstone][PATCH 1/9] release-notes-4.0.17: reorder CVEs michael.opdenacker
@ 2024-04-14 18:20 ` michael.opdenacker
2024-04-14 18:20 ` [kirkstone][PATCH 3/9] manuals: refer to new yocto-patches mailing list wherever appropriate michael.opdenacker
` (6 subsequent siblings)
8 siblings, 0 replies; 10+ messages in thread
From: michael.opdenacker @ 2024-04-14 18:20 UTC (permalink / raw)
To: docs; +Cc: Michael Opdenacker, Quentin Schulz, Quentin Schulz
From: Michael Opdenacker <michael.opdenacker@bootlin.com>
From: Quentin Schulz <quentin.schulz@theobroma-systems.com>
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 <foss+yocto@0leil.net>
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
documentation/conf.py | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/documentation/conf.py b/documentation/conf.py
index 5ff5ec8655..83cf829e6a 100644
--- a/documentation/conf.py
+++ b/documentation/conf.py
@@ -159,8 +159,8 @@ html_last_updated_fmt = '%b %d, %Y'
html_secnumber_suffix = " "
latex_elements = {
- 'passoptionstopackages': '\PassOptionsToPackage{bookmarksdepth=5}{hyperref}',
- 'preamble': '\setcounter{tocdepth}{2}',
+ 'passoptionstopackages': '\\PassOptionsToPackage{bookmarksdepth=5}{hyperref}',
+ 'preamble': '\\setcounter{tocdepth}{2}',
}
# Make the EPUB builder prefer PNG to SVG because of issues rendering Inkscape SVG
--
2.34.1
^ permalink raw reply related [flat|nested] 10+ messages in thread
* [kirkstone][PATCH 3/9] manuals: refer to new yocto-patches mailing list wherever appropriate
2024-04-14 18:20 [kirkstone][PATCH 0/9] documentation backports michael.opdenacker
2024-04-14 18:20 ` [kirkstone][PATCH 1/9] release-notes-4.0.17: reorder CVEs michael.opdenacker
2024-04-14 18:20 ` [kirkstone][PATCH 2/9] docs: conf.py: properly escape backslashes for latex_elements michael.opdenacker
@ 2024-04-14 18:20 ` michael.opdenacker
2024-04-14 18:20 ` [kirkstone][PATCH 4/9] manuals: fix duplicate "stylecheck" target michael.opdenacker
` (5 subsequent siblings)
8 siblings, 0 replies; 10+ messages in thread
From: michael.opdenacker @ 2024-04-14 18:20 UTC (permalink / raw)
To: docs; +Cc: Michael Opdenacker, Quentin Schulz, Quentin Schulz
From: Michael Opdenacker <michael.opdenacker@bootlin.com>
From: Quentin Schulz <quentin.schulz@theobroma-systems.com>
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 <foss+yocto@0leil.net>
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
documentation/contributor-guide/submit-changes.rst | 2 +-
documentation/ref-manual/resources.rst | 3 +++
2 files changed, 4 insertions(+), 1 deletion(-)
diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst
index 15566701f6..25f839ba03 100644
--- a/documentation/contributor-guide/submit-changes.rst
+++ b/documentation/contributor-guide/submit-changes.rst
@@ -399,7 +399,7 @@ varies by component:
For changes to other layers and tools hosted in the Yocto Project source
repositories (i.e. :yocto_git:`git.yoctoproject.org <>`), use the
-:yocto_lists:`yocto </g/yocto/>` general mailing list.
+:yocto_lists:`yocto-patches </g/yocto-patches/>` general mailing list.
For changes to other layers hosted in the OpenEmbedded source
repositories (i.e. :oe_git:`git.openembedded.org <>`), use
diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst
index 8e54ac87c9..4eaaca942e 100644
--- a/documentation/ref-manual/resources.rst
+++ b/documentation/ref-manual/resources.rst
@@ -66,6 +66,9 @@ instructions:
- :yocto_lists:`/g/yocto` --- general Yocto Project
discussion mailing list.
+- :yocto_lists:`/g/yocto-patches` --- patch contribution mailing list for Yocto
+ Project-related layers which do not have their own mailing list.
+
- :oe_lists:`/g/openembedded-core` --- discussion mailing
list about OpenEmbedded-Core (the core metadata).
--
2.34.1
^ permalink raw reply related [flat|nested] 10+ messages in thread
* [kirkstone][PATCH 4/9] manuals: fix duplicate "stylecheck" target
2024-04-14 18:20 [kirkstone][PATCH 0/9] documentation backports michael.opdenacker
` (2 preceding siblings ...)
2024-04-14 18:20 ` [kirkstone][PATCH 3/9] manuals: refer to new yocto-patches mailing list wherever appropriate michael.opdenacker
@ 2024-04-14 18:20 ` michael.opdenacker
2024-04-14 18:20 ` [kirkstone][PATCH 5/9] manuals: add initial sphinx-lint support michael.opdenacker
` (4 subsequent siblings)
8 siblings, 0 replies; 10+ messages in thread
From: michael.opdenacker @ 2024-04-14 18:20 UTC (permalink / raw)
To: docs; +Cc: Michael Opdenacker, Quentin Schulz
From: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
---
documentation/Makefile | 4 ----
1 file changed, 4 deletions(-)
diff --git a/documentation/Makefile b/documentation/Makefile
index e5f0effeb5..20dab5725c 100644
--- a/documentation/Makefile
+++ b/documentation/Makefile
@@ -53,10 +53,6 @@ stylecheck:
vale sync
vale $(VALEOPTS) $(VALEDOCS)
-stylecheck:
- vale sync
- vale $(VALEOPTS) $(VALEDOCS)
-
epub: $(PNGs)
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
--
2.34.1
^ permalink raw reply related [flat|nested] 10+ messages in thread
* [kirkstone][PATCH 5/9] manuals: add initial sphinx-lint support
2024-04-14 18:20 [kirkstone][PATCH 0/9] documentation backports michael.opdenacker
` (3 preceding siblings ...)
2024-04-14 18:20 ` [kirkstone][PATCH 4/9] manuals: fix duplicate "stylecheck" target michael.opdenacker
@ 2024-04-14 18:20 ` michael.opdenacker
2024-04-14 18:20 ` [kirkstone][PATCH 6/9] manuals: fix trailing spaces michael.opdenacker
` (3 subsequent siblings)
8 siblings, 0 replies; 10+ messages in thread
From: michael.opdenacker @ 2024-04-14 18:20 UTC (permalink / raw)
To: docs; +Cc: Michael Opdenacker
From: Michael Opdenacker <michael.opdenacker@bootlin.com>
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".
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
documentation/Makefile | 3 +++
documentation/README | 14 ++++++++++++++
2 files changed, 17 insertions(+)
diff --git a/documentation/Makefile b/documentation/Makefile
index 20dab5725c..4e0af4bd30 100644
--- a/documentation/Makefile
+++ b/documentation/Makefile
@@ -53,6 +53,9 @@ stylecheck:
vale sync
vale $(VALEOPTS) $(VALEDOCS)
+sphinx-lint:
+ sphinx-lint $(SOURCEDIR)
+
epub: $(PNGs)
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/documentation/README b/documentation/README
index 8035418cac..b60472fcbf 100644
--- a/documentation/README
+++ b/documentation/README
@@ -165,6 +165,20 @@ To run Vale:
$ make stylecheck
+Link checking the Yocto Project documentation
+=============================================
+
+To fix errors which are not reported by Sphinx itself,
+the project uses sphinx-lint (https://github.com/sphinx-contrib/sphinx-lint).
+
+To install sphinx-lint:
+
+ $ pip install sphinx-lint
+
+To run sphinx-lint:
+
+ $ make sphinx-lint
+
Sphinx theme and CSS customization
==================================
--
2.34.1
^ permalink raw reply related [flat|nested] 10+ messages in thread
* [kirkstone][PATCH 6/9] manuals: fix trailing spaces
2024-04-14 18:20 [kirkstone][PATCH 0/9] documentation backports michael.opdenacker
` (4 preceding siblings ...)
2024-04-14 18:20 ` [kirkstone][PATCH 5/9] manuals: add initial sphinx-lint support michael.opdenacker
@ 2024-04-14 18:20 ` michael.opdenacker
2024-04-14 18:20 ` [kirkstone][PATCH 7/9] manuals: fix incorrect double backticks michael.opdenacker
` (2 subsequent siblings)
8 siblings, 0 replies; 10+ messages in thread
From: michael.opdenacker @ 2024-04-14 18:20 UTC (permalink / raw)
To: docs; +Cc: Michael Opdenacker
From: Michael Opdenacker <michael.opdenacker@bootlin.com>
Fixing errors reported by "make sphinx-lint"
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
documentation/dev-manual/init-manager.rst | 2 +-
documentation/dev-manual/start.rst | 12 +++++++----
documentation/dev-manual/wic.rst | 4 ++--
.../migration-guides/migration-4.0.rst | 20 +++++++++----------
.../migration-guides/release-notes-4.0.5.rst | 2 +-
.../migration-guides/release-notes-4.0.rst | 17 ++++++++--------
documentation/overview-manual/intro.rst | 2 +-
documentation/ref-manual/classes.rst | 2 +-
documentation/ref-manual/tasks.rst | 2 +-
documentation/ref-manual/variables.rst | 2 +-
10 files changed, 34 insertions(+), 31 deletions(-)
diff --git a/documentation/dev-manual/init-manager.rst b/documentation/dev-manual/init-manager.rst
index 20d61ea830..ddce82b81f 100644
--- a/documentation/dev-manual/init-manager.rst
+++ b/documentation/dev-manual/init-manager.rst
@@ -121,7 +121,7 @@ increasing levels of complexity and functionality:
:widths: 40 20 20 20
:header-rows: 1
- * -
+ * -
- BusyBox init
- SysVinit
- systemd
diff --git a/documentation/dev-manual/start.rst b/documentation/dev-manual/start.rst
index 7b6026cf42..aec39b02a9 100644
--- a/documentation/dev-manual/start.rst
+++ b/documentation/dev-manual/start.rst
@@ -612,10 +612,14 @@ Use the following procedure to locate the latest upstream copy of the
Accessing Index of Releases
---------------------------
-Yocto Project maintains an Index of Releases area that contains related
-files that contribute to the Yocto Project. Rather than Git
-repositories, these files are tarballs that represent snapshots in time
-of a given component.
+The Yocto Project also provides source archives of its releases, which
+are available on :yocto_dl:`/releases/yocto/`. Then, choose the subdirectory
+containing the release you wish to use, for example
+:yocto_dl:`yocto-&DISTRO; </releases/yocto/yocto-&DISTRO;/>`.
+
+You will find there source archives of individual components (if you wish
+to use them individually), and of the corresponding Poky release bundling
+a selection of these components.
.. note::
diff --git a/documentation/dev-manual/wic.rst b/documentation/dev-manual/wic.rst
index f794693c50..687c9e6580 100644
--- a/documentation/dev-manual/wic.rst
+++ b/documentation/dev-manual/wic.rst
@@ -146,7 +146,7 @@ command to return the available Wic images as follows::
mkefidisk Create an EFI disk image
directdisk-multi-rootfs Create multi rootfs image using rootfs plugin
directdisk Create a 'pcbios' direct disk image
- efi-bootdisk
+ efi-bootdisk
mkhybridiso Create a hybrid ISO image
directdisk-gpt Create a 'pcbios' direct disk image
systemd-bootdisk Create an EFI disk image with systemd-boot
@@ -290,7 +290,7 @@ Use the following command to list the available kickstart files::
mkefidisk Create an EFI disk image
directdisk-multi-rootfs Create multi rootfs image using rootfs plugin
directdisk Create a 'pcbios' direct disk image
- efi-bootdisk
+ efi-bootdisk
mkhybridiso Create a hybrid ISO image
directdisk-gpt Create a 'pcbios' direct disk image
systemd-bootdisk Create an EFI disk image with systemd-boot
diff --git a/documentation/migration-guides/migration-4.0.rst b/documentation/migration-guides/migration-4.0.rst
index 93576d4538..5e240457c0 100644
--- a/documentation/migration-guides/migration-4.0.rst
+++ b/documentation/migration-guides/migration-4.0.rst
@@ -66,7 +66,7 @@ changes and you need to review them before committing. An example warning
looks like::
poky/scripts/lib/devtool/upgrade.py needs further work at line 275 since it contains abort
-
+
Fetching changes
~~~~~~~~~~~~~~~~
@@ -109,7 +109,7 @@ License changes
If they do not, by default a warning will be shown. A
:oe_git:`convert-spdx-licenses.py </openembedded-core/tree/scripts/contrib/convert-spdx-licenses.py>`
script can be used to update your recipes.
-
+
- :term:`INCOMPATIBLE_LICENSE` should now use `SPDX identifiers <https://spdx.org/licenses/>`__.
Additionally, wildcarding is now limited to specifically supported values -
see the :term:`INCOMPATIBLE_LICENSE` documentation for further information.
@@ -119,7 +119,7 @@ License changes
which can cause signature issues for users. In addition the ``available_licenses()``
function has been removed from the :ref:`license <ref-classes-license>` class as
it is no longer needed.
-
+
Removed recipes
~~~~~~~~~~~~~~~
@@ -134,11 +134,11 @@ The following recipes have been removed in this release:
Python changes
~~~~~~~~~~~~~~
-
+
- ``distutils`` has been deprecated upstream in Python 3.10 and thus the ``distutils*``
classes have been moved to ``meta-python``. Recipes that inherit the ``distutils*``
classes should be updated to inherit ``setuptools*`` equivalents instead.
-
+
- The Python package build process is now based on `wheels <https://pythonwheels.com/>`__.
The new Python packaging classes that should be used are
:ref:`python_flit_core <ref-classes-python_flit_core>`,
@@ -158,7 +158,7 @@ Prelink removed
Prelink has been dropped by ``glibc`` upstream in 2.36. It already caused issues with
binary corruption, has a number of open bugs and is of questionable benefit
without disabling load address randomization and PIE executables.
-
+
We disabled prelinking by default in the honister (3.4) release, but left it able
to be enabled if desired. However, without glibc support it cannot be maintained
any further, so all of the prelinking functionality has been removed in this release.
@@ -169,7 +169,7 @@ reference(s).
Reproducible as standard
~~~~~~~~~~~~~~~~~~~~~~~~
-Reproducibility is now considered as standard functionality, thus the
+Reproducibility is now considered as standard functionality, thus the
``reproducible`` class has been removed and its previous contents merged into the
:ref:`base <ref-classes-base>` class. If you have references in your configuration to
``reproducible`` in :term:`INHERIT`, :term:`USER_CLASSES` etc. then they should be
@@ -211,7 +211,7 @@ and :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:removal (over
Miscellaneous changes
~~~~~~~~~~~~~~~~~~~~~
-
+
- ``blacklist.bbclass`` is removed and the functionality moved to the
:ref:`base <ref-classes-base>` class with a more descriptive
``varflag`` variable named :term:`SKIP_RECIPE` which will use the `bb.parse.SkipRecipe()`
@@ -251,7 +251,7 @@ Miscellaneous changes
- The ``cortexa72-crc`` and ``cortexa72-crc-crypto`` tunes have been removed since
the crc extension is now enabled by default for cortexa72. Replace any references to
these with ``cortexa72`` and ``cortexa72-crypto`` respectively.
-
+
- The Python development shell (previously known as ``devpyshell``) feature has been
renamed to ``pydevshell``. To start it you should now run::
@@ -260,7 +260,7 @@ Miscellaneous changes
- The ``packagegroups-core-full-cmdline-libs`` packagegroup is no longer produced, as
libraries should normally be brought in via dependencies. If you have any references
to this then remove them.
-
+
- The :term:`TOPDIR` variable and the current working directory are no longer modified
when parsing recipes. Any code depending on the previous behaviour will no longer
work - change any such code to explicitly use appropriate path variables instead.
diff --git a/documentation/migration-guides/release-notes-4.0.5.rst b/documentation/migration-guides/release-notes-4.0.5.rst
index ea0280b03c..95cc6f6d30 100644
--- a/documentation/migration-guides/release-notes-4.0.5.rst
+++ b/documentation/migration-guides/release-notes-4.0.5.rst
@@ -81,7 +81,7 @@ Fixes in Yocto-4.0.5
Known Issues in Yocto-4.0.5
~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- There are recent CVEs in key components such as openssl. They are not included in this release as it was built before the issues were known and fixes were available but these are now available on the kirkstone branch.
+- There are recent CVEs in key components such as openssl. They are not included in this release as it was built before the issues were known and fixes were available but these are now available on the kirkstone branch.
Contributors to Yocto-4.0.5
diff --git a/documentation/migration-guides/release-notes-4.0.rst b/documentation/migration-guides/release-notes-4.0.rst
index b675cae217..11206072a0 100644
--- a/documentation/migration-guides/release-notes-4.0.rst
+++ b/documentation/migration-guides/release-notes-4.0.rst
@@ -36,7 +36,7 @@ New Features / Enhancements in 4.0
- Inclusive language adjustments to some variable names - see the
:ref:`4.0 migration guide <migration-4.0-inclusive-language>` for details.
-
+
- New recipes:
- ``buildtools-docs-tarball``
@@ -112,8 +112,7 @@ New Features / Enhancements in 4.0
- BitBake enhancements:
- Fetcher enhancements:
-
- - New :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-fetching:crate fetcher (\`\`crate://\`\`)` for Rust packages
+ - New :ref:`bitbake-user-manual/bitbake-user-manual-fetching:crate fetcher (\`\`crate://\`\`)` for Rust packages
- Added striplevel support to unpack
- git: Add a warning asking users to set a branch in git urls
- git: Allow git fetcher to support subdir param
@@ -125,7 +124,7 @@ New Features / Enhancements in 4.0
- ssh: now supports checkstatus, allows : in URLs (both required for use with sstate) and no longer requires username
- wget: add redirectauth parameter
- wget: add 30s timeout for checkstatus calls
-
+
- Show warnings for append/prepend/remove operators combined with +=/.=
- Add bb.warnonce() and bb.erroronce() log methods
- Improved setscene task display
@@ -138,7 +137,7 @@ New Features / Enhancements in 4.0
- Architecture-specific enhancements:
- ARM:
-
+
- tune-cortexa72: Enable the crc extension by default for cortexa72
- qemuarm64: Add tiny ktype to qemuarm64 bsp
- armv9a/tune: Add the support for the Neoverse N2 core
@@ -161,7 +160,7 @@ New Features / Enhancements in 4.0
- linux-yocto-dev: add qemuriscv32
- packagegroup-core-tools-profile: Enable systemtap for riscv64
- qemuriscv: Use virtio-tablet-pci for mouse
-
+
- x86:
- kernel-yocto: conditionally enable stack protection checking on x86-64
@@ -197,7 +196,7 @@ New Features / Enhancements in 4.0
- yocto-check-layer: improved README checks
- cve-check: add json output format
- cve-check: add coverage statistics on recipes with/without CVEs
-- Added mirrors for kernel sources and uninative binaries on kernel.org
+- Added mirrors for kernel sources and uninative binaries on kernel.org
- glibc and binutils recipes now use shallow mirror tarballs for faster fetching
- When patching fails, show more information on the fatal error
@@ -232,7 +231,7 @@ New Features / Enhancements in 4.0
- Detect more known licenses in Python code
- Move license md5sums data into CSV files
- npm: Use README as license fallback
-
+
- SDK-related enhancements:
- Extended recipes to ``nativesdk``: ``cargo``, ``librsvg``, ``libstd-rs``, ``libva``, ``python3-docutil``, ``python3-packaging``
@@ -240,7 +239,7 @@ New Features / Enhancements in 4.0
- Support creating per-toolchain cmake file in SDK
- Rust enhancements:
-
+
- New python_setuptools3_rust class to enable building python extensions in Rust
- classes/meson: Add optional rust definitions
diff --git a/documentation/overview-manual/intro.rst b/documentation/overview-manual/intro.rst
index a8091771f4..80446b3810 100644
--- a/documentation/overview-manual/intro.rst
+++ b/documentation/overview-manual/intro.rst
@@ -38,7 +38,7 @@ This manual does not give you the following:
procedures reside in other manuals within the Yocto Project
documentation set. For example, the :doc:`/dev-manual/index`
provides examples on how to perform
- various development tasks. As another example, the
+ various development tasks. As another example, the
:doc:`/sdk-manual/index` manual contains detailed
instructions on how to install an SDK, which is used to develop
applications for target hardware.
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index e7bf5e9a6e..43bdc8bd25 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -588,7 +588,7 @@ The padding size can be modified by setting :term:`DT_PADDING_SIZE`
to the desired size, in bytes.
See :oe_git:`devicetree.bbclass sources
-</openembedded-core/tree/meta/classes-recipe/devicetree.bbclass>`
+</openembedded-core/tree/meta/classes-recipe/devicetree.bbclass>`
for further variables controlling this class.
Here is an excerpt of an example ``recipes-kernel/linux/devicetree-acme.bb``
diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst
index 0f1f95b9ff..346e9491f3 100644
--- a/documentation/ref-manual/tasks.rst
+++ b/documentation/ref-manual/tasks.rst
@@ -369,7 +369,7 @@ information.
``do_populate_sdk_ext``
-----------------------
-Creates the file and directory structure for an installable extensible
+Creates the file and directory structure for an installable extensible
SDK (eSDK). See the ":ref:`overview-manual/concepts:sdk generation`"
section in the Yocto Project Overview and Concepts Manual for more
information.
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 5e5b688878..c2a6566341 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -7601,7 +7601,7 @@ system and gives an overview of their function and contents.
The name of keys used by the :ref:`ref-classes-kernel-fitimage` class
for signing U-Boot FIT image stored in the :term:`SPL_SIGN_KEYDIR`
directory. If we have for example a ``dev.key`` key and a ``dev.crt``
- certificate stored in the :term:`SPL_SIGN_KEYDIR` directory, you will
+ certificate stored in the :term:`SPL_SIGN_KEYDIR` directory, you will
have to set :term:`SPL_SIGN_KEYNAME` to ``dev``.
:term:`SPLASH`
--
2.34.1
^ permalink raw reply related [flat|nested] 10+ messages in thread
* [kirkstone][PATCH 7/9] manuals: fix incorrect double backticks
2024-04-14 18:20 [kirkstone][PATCH 0/9] documentation backports michael.opdenacker
` (5 preceding siblings ...)
2024-04-14 18:20 ` [kirkstone][PATCH 6/9] manuals: fix trailing spaces michael.opdenacker
@ 2024-04-14 18:20 ` michael.opdenacker
2024-04-14 18:20 ` [kirkstone][PATCH 8/9] kernel-dev: join mkdir commands with -p michael.opdenacker
2024-04-14 18:20 ` [kirkstone][PATCH 9/9] manuals: remove tab characters michael.opdenacker
8 siblings, 0 replies; 10+ messages in thread
From: michael.opdenacker @ 2024-04-14 18:20 UTC (permalink / raw)
To: docs; +Cc: Michael Opdenacker
From: Michael Opdenacker <michael.opdenacker@bootlin.com>
As reported by "make sphinx-lint"
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
documentation/profile-manual/usage.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/documentation/profile-manual/usage.rst b/documentation/profile-manual/usage.rst
index 542bd918b9..cffb63e3f9 100644
--- a/documentation/profile-manual/usage.rst
+++ b/documentation/profile-manual/usage.rst
@@ -1853,7 +1853,7 @@ Practically speaking, that means you need to do the following:
- Or build a non-SDK image but include the profiling tools
(edit ``local.conf`` and add ``tools-profile`` to the end of
- :term:``EXTRA_IMAGE_FEATURES`` variable)::
+ :term:`EXTRA_IMAGE_FEATURES` variable)::
$ bitbake core-image-sato
--
2.34.1
^ permalink raw reply related [flat|nested] 10+ messages in thread
* [kirkstone][PATCH 8/9] kernel-dev: join mkdir commands with -p
2024-04-14 18:20 [kirkstone][PATCH 0/9] documentation backports michael.opdenacker
` (6 preceding siblings ...)
2024-04-14 18:20 ` [kirkstone][PATCH 7/9] manuals: fix incorrect double backticks michael.opdenacker
@ 2024-04-14 18:20 ` michael.opdenacker
2024-04-14 18:20 ` [kirkstone][PATCH 9/9] manuals: remove tab characters michael.opdenacker
8 siblings, 0 replies; 10+ messages in thread
From: michael.opdenacker @ 2024-04-14 18:20 UTC (permalink / raw)
To: docs; +Cc: Michael Opdenacker, Jörg Sommer
From: Michael Opdenacker <michael.opdenacker@bootlin.com>
From: Jörg Sommer <joerg.sommer@navimatix.de>
To make it more obvious which directories are needed, pass only these to
*mkdir* and use the option `-p` to create the missing parents.
Signed-off-by: Jörg Sommer <joerg.sommer@navimatix.de>
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
documentation/kernel-dev/common.rst | 10 ++--------
1 file changed, 2 insertions(+), 8 deletions(-)
diff --git a/documentation/kernel-dev/common.rst b/documentation/kernel-dev/common.rst
index cbcb30281a..3f9d8d48e4 100644
--- a/documentation/kernel-dev/common.rst
+++ b/documentation/kernel-dev/common.rst
@@ -383,11 +383,7 @@ home directory:
1. *Create Structure*: Create the layer's structure::
- $ mkdir meta-mylayer
- $ mkdir meta-mylayer/conf
- $ mkdir meta-mylayer/recipes-kernel
- $ mkdir meta-mylayer/recipes-kernel/linux
- $ mkdir meta-mylayer/recipes-kernel/linux/linux-yocto
+ $ mkdir -p meta-mylayer/conf meta-mylayer/recipes-kernel/linux/linux-yocto
The ``conf`` directory holds your configuration files, while the
``recipes-kernel`` directory holds your append file and eventual
@@ -1044,9 +1040,7 @@ Section.
additional structure to your layer using the following commands::
$ cd ~/meta-mylayer
- $ mkdir recipes-kernel
- $ mkdir recipes-kernel/linux
- $ mkdir recipes-kernel/linux/linux-yocto
+ $ mkdir -p recipes-kernel recipes-kernel/linux/linux-yocto
Once you have created this
hierarchy in your layer, you can move the patch file using the
--
2.34.1
^ permalink raw reply related [flat|nested] 10+ messages in thread
* [kirkstone][PATCH 9/9] manuals: remove tab characters
2024-04-14 18:20 [kirkstone][PATCH 0/9] documentation backports michael.opdenacker
` (7 preceding siblings ...)
2024-04-14 18:20 ` [kirkstone][PATCH 8/9] kernel-dev: join mkdir commands with -p michael.opdenacker
@ 2024-04-14 18:20 ` michael.opdenacker
8 siblings, 0 replies; 10+ messages in thread
From: michael.opdenacker @ 2024-04-14 18:20 UTC (permalink / raw)
To: docs; +Cc: Michael Opdenacker, Quentin Schulz
From: Michael Opdenacker <michael.opdenacker@bootlin.com>
As reported by "make sphinx-lint"
Tabs are even removed in Makefile examples,
as Sphinx turns them to spaces anyway in the generated output.
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
---
documentation/dev-manual/layers.rst | 16 +--
documentation/dev-manual/wic.rst | 52 ++++----
documentation/kernel-dev/advanced.rst | 4 +-
documentation/kernel-dev/common.rst | 4 +-
documentation/profile-manual/usage.rst | 114 +++++++++---------
documentation/ref-manual/terms.rst | 10 +-
documentation/sdk-manual/working-projects.rst | 10 +-
7 files changed, 105 insertions(+), 105 deletions(-)
diff --git a/documentation/dev-manual/layers.rst b/documentation/dev-manual/layers.rst
index 9bfbd726d9..e3f56199be 100644
--- a/documentation/dev-manual/layers.rst
+++ b/documentation/dev-manual/layers.rst
@@ -501,12 +501,12 @@ the "meta" layer at ``meta/recipes-bsp/formfactor``::
INHIBIT_DEFAULT_DEPS = "1"
do_install() {
- # Install file only if it has contents
+ # Install file only if it has contents
install -d ${D}${sysconfdir}/formfactor/
install -m 0644 ${S}/config ${D}${sysconfdir}/formfactor/
- if [ -s "${S}/machconfig" ]; then
- install -m 0644 ${S}/machconfig ${D}${sysconfdir}/formfactor/
- fi
+ if [ -s "${S}/machconfig" ]; then
+ install -m 0644 ${S}/machconfig ${D}${sysconfdir}/formfactor/
+ fi
}
In the main recipe, note the :term:`SRC_URI`
@@ -582,10 +582,10 @@ Directory`. Here is the main ``xserver-xf86-config`` recipe, which is named
ALLOW_EMPTY:${PN} = "1"
do_install () {
- if test -s ${WORKDIR}/xorg.conf; then
- install -d ${D}/${sysconfdir}/X11
- install -m 0644 ${WORKDIR}/xorg.conf ${D}/${sysconfdir}/X11/
- fi
+ if test -s ${WORKDIR}/xorg.conf; then
+ install -d ${D}/${sysconfdir}/X11
+ install -m 0644 ${WORKDIR}/xorg.conf ${D}/${sysconfdir}/X11/
+ fi
}
Here is the append file, which is named ``xserver-xf86-config_%.bbappend``
diff --git a/documentation/dev-manual/wic.rst b/documentation/dev-manual/wic.rst
index 687c9e6580..049996c39e 100644
--- a/documentation/dev-manual/wic.rst
+++ b/documentation/dev-manual/wic.rst
@@ -139,20 +139,20 @@ individual images through the ``list`` command. You can use the ``list``
command to return the available Wic images as follows::
$ wic list images
- genericx86 Create an EFI disk image for genericx86*
- edgerouter Create SD card image for Edgerouter
- beaglebone-yocto Create SD card image for Beaglebone
- qemuriscv Create qcow2 image for RISC-V QEMU machines
- mkefidisk Create an EFI disk image
- directdisk-multi-rootfs Create multi rootfs image using rootfs plugin
- directdisk Create a 'pcbios' direct disk image
+ genericx86 Create an EFI disk image for genericx86*
+ edgerouter Create SD card image for Edgerouter
+ beaglebone-yocto Create SD card image for Beaglebone
+ qemuriscv Create qcow2 image for RISC-V QEMU machines
+ mkefidisk Create an EFI disk image
+ directdisk-multi-rootfs Create multi rootfs image using rootfs plugin
+ directdisk Create a 'pcbios' direct disk image
efi-bootdisk
- mkhybridiso Create a hybrid ISO image
- directdisk-gpt Create a 'pcbios' direct disk image
- systemd-bootdisk Create an EFI disk image with systemd-boot
- sdimage-bootpart Create SD card image with a boot partition
- qemux86-directdisk Create a qemu machine 'pcbios' direct disk image
- directdisk-bootloader-config Create a 'pcbios' direct disk image with custom bootloader config
+ mkhybridiso Create a hybrid ISO image
+ directdisk-gpt Create a 'pcbios' direct disk image
+ systemd-bootdisk Create an EFI disk image with systemd-boot
+ sdimage-bootpart Create SD card image with a boot partition
+ qemux86-directdisk Create a qemu machine 'pcbios' direct disk image
+ directdisk-bootloader-config Create a 'pcbios' direct disk image with custom bootloader config
Once you know the list of available
@@ -283,20 +283,20 @@ following two locations::
Use the following command to list the available kickstart files::
$ wic list images
- genericx86 Create an EFI disk image for genericx86*
- edgerouter Create SD card image for Edgerouter
- beaglebone-yocto Create SD card image for Beaglebone
- qemuriscv Create qcow2 image for RISC-V QEMU machines
- mkefidisk Create an EFI disk image
- directdisk-multi-rootfs Create multi rootfs image using rootfs plugin
- directdisk Create a 'pcbios' direct disk image
+ genericx86 Create an EFI disk image for genericx86*
+ edgerouter Create SD card image for Edgerouter
+ beaglebone-yocto Create SD card image for Beaglebone
+ qemuriscv Create qcow2 image for RISC-V QEMU machines
+ mkefidisk Create an EFI disk image
+ directdisk-multi-rootfs Create multi rootfs image using rootfs plugin
+ directdisk Create a 'pcbios' direct disk image
efi-bootdisk
- mkhybridiso Create a hybrid ISO image
- directdisk-gpt Create a 'pcbios' direct disk image
- systemd-bootdisk Create an EFI disk image with systemd-boot
- sdimage-bootpart Create SD card image with a boot partition
- qemux86-directdisk Create a qemu machine 'pcbios' direct disk image
- directdisk-bootloader-config Create a 'pcbios' direct disk image with custom bootloader config
+ mkhybridiso Create a hybrid ISO image
+ directdisk-gpt Create a 'pcbios' direct disk image
+ systemd-bootdisk Create an EFI disk image with systemd-boot
+ sdimage-bootpart Create SD card image with a boot partition
+ qemux86-directdisk Create a qemu machine 'pcbios' direct disk image
+ directdisk-bootloader-config Create a 'pcbios' direct disk image with custom bootloader config
When you use an existing file, you
do not have to use the ``.wks`` extension. Here is an example in Raw
diff --git a/documentation/kernel-dev/advanced.rst b/documentation/kernel-dev/advanced.rst
index eae2d49ba4..f4820a4ad2 100644
--- a/documentation/kernel-dev/advanced.rst
+++ b/documentation/kernel-dev/advanced.rst
@@ -303,8 +303,8 @@ The following listings show the ``build.scc`` file and part of the
.
.
.
- char *dump_write = NULL, *files_source = NULL;
- int opt;
+ char *dump_write = NULL, *files_source = NULL;
+ int opt;
--
2.10.1
diff --git a/documentation/kernel-dev/common.rst b/documentation/kernel-dev/common.rst
index 3f9d8d48e4..815695652b 100644
--- a/documentation/kernel-dev/common.rst
+++ b/documentation/kernel-dev/common.rst
@@ -1749,10 +1749,10 @@ looks much like the one provided with the ``hello-mod`` template::
SRC := $(shell pwd)
all:
- $(MAKE) -C $(KERNEL_SRC) M=$(SRC)
+ $(MAKE) -C $(KERNEL_SRC) M=$(SRC)
modules_install:
- $(MAKE) -C $(KERNEL_SRC) M=$(SRC) modules_install
+ $(MAKE) -C $(KERNEL_SRC) M=$(SRC) modules_install
...
The important point to note here is the :term:`KERNEL_SRC` variable. The
diff --git a/documentation/profile-manual/usage.rst b/documentation/profile-manual/usage.rst
index cffb63e3f9..2ff12f434e 100644
--- a/documentation/profile-manual/usage.rst
+++ b/documentation/profile-manual/usage.rst
@@ -1044,13 +1044,13 @@ section::
name: do_fork
ID: 944
format:
- field:unsigned short common_type; offset:0; size:2; signed:0;
- field:unsigned char common_flags; offset:2; size:1; signed:0;
- field:unsigned char common_preempt_count; offset:3; size:1; signed:0;
- field:int common_pid; offset:4; size:4; signed:1;
- field:int common_padding; offset:8; size:4; signed:1;
+ field:unsigned short common_type; offset:0; size:2; signed:0;
+ field:unsigned char common_flags; offset:2; size:1; signed:0;
+ field:unsigned char common_preempt_count; offset:3; size:1; signed:0;
+ field:int common_pid; offset:4; size:4; signed:1;
+ field:int common_padding; offset:8; size:4; signed:1;
- field:unsigned long __probe_ip; offset:12; size:4; signed:0;
+ field:unsigned long __probe_ip; offset:12; size:4; signed:0;
print fmt: "(%lx)", REC->__probe_ip
@@ -1535,17 +1535,17 @@ like ftrace to display the event as text. The format of the
name: kmalloc
ID: 313
format:
- field:unsigned short common_type; offset:0; size:2; signed:0;
- field:unsigned char common_flags; offset:2; size:1; signed:0;
- field:unsigned char common_preempt_count; offset:3; size:1; signed:0;
- field:int common_pid; offset:4; size:4; signed:1;
- field:int common_padding; offset:8; size:4; signed:1;
-
- field:unsigned long call_site; offset:16; size:8; signed:0;
- field:const void * ptr; offset:24; size:8; signed:0;
- field:size_t bytes_req; offset:32; size:8; signed:0;
- field:size_t bytes_alloc; offset:40; size:8; signed:0;
- field:gfp_t gfp_flags; offset:48; size:4; signed:0;
+ field:unsigned short common_type; offset:0; size:2; signed:0;
+ field:unsigned char common_flags; offset:2; size:1; signed:0;
+ field:unsigned char common_preempt_count; offset:3; size:1; signed:0;
+ field:int common_pid; offset:4; size:4; signed:1;
+ field:int common_padding; offset:8; size:4; signed:1;
+
+ field:unsigned long call_site; offset:16; size:8; signed:0;
+ field:const void * ptr; offset:24; size:8; signed:0;
+ field:size_t bytes_req; offset:32; size:8; signed:0;
+ field:size_t bytes_alloc; offset:40; size:8; signed:0;
+ field:gfp_t gfp_flags; offset:48; size:4; signed:0;
print fmt: "call_site=%lx ptr=%p bytes_req=%zu bytes_alloc=%zu gfp_flags=%s", REC->call_site, REC->ptr, REC->bytes_req, REC->bytes_alloc,
(REC->gfp_flags) ? __print_flags(REC->gfp_flags, "|", {(unsigned long)(((( gfp_t)0x10u) | (( gfp_t)0x40u) | (( gfp_t)0x80u) | ((
@@ -2333,29 +2333,29 @@ first part of the filenames::
8,32 1 0 58.516990819 0 m N cfq3551 put_queue
CPU0 (sdc):
- Reads Queued: 0, 0KiB Writes Queued: 331, 26,284KiB
- Read Dispatches: 0, 0KiB Write Dispatches: 485, 40,484KiB
- Reads Requeued: 0 Writes Requeued: 0
- Reads Completed: 0, 0KiB Writes Completed: 511, 41,000KiB
- Read Merges: 0, 0KiB Write Merges: 13, 160KiB
- Read depth: 0 Write depth: 2
- IO unplugs: 23 Timer unplugs: 0
+ Reads Queued: 0, 0KiB Writes Queued: 331, 26,284KiB
+ Read Dispatches: 0, 0KiB Write Dispatches: 485, 40,484KiB
+ Reads Requeued: 0 Writes Requeued: 0
+ Reads Completed: 0, 0KiB Writes Completed: 511, 41,000KiB
+ Read Merges: 0, 0KiB Write Merges: 13, 160KiB
+ Read depth: 0 Write depth: 2
+ IO unplugs: 23 Timer unplugs: 0
CPU1 (sdc):
- Reads Queued: 0, 0KiB Writes Queued: 249, 15,800KiB
- Read Dispatches: 0, 0KiB Write Dispatches: 42, 1,600KiB
- Reads Requeued: 0 Writes Requeued: 0
- Reads Completed: 0, 0KiB Writes Completed: 16, 1,084KiB
- Read Merges: 0, 0KiB Write Merges: 40, 276KiB
- Read depth: 0 Write depth: 2
- IO unplugs: 30 Timer unplugs: 1
+ Reads Queued: 0, 0KiB Writes Queued: 249, 15,800KiB
+ Read Dispatches: 0, 0KiB Write Dispatches: 42, 1,600KiB
+ Reads Requeued: 0 Writes Requeued: 0
+ Reads Completed: 0, 0KiB Writes Completed: 16, 1,084KiB
+ Read Merges: 0, 0KiB Write Merges: 40, 276KiB
+ Read depth: 0 Write depth: 2
+ IO unplugs: 30 Timer unplugs: 1
Total (sdc):
- Reads Queued: 0, 0KiB Writes Queued: 580, 42,084KiB
- Read Dispatches: 0, 0KiB Write Dispatches: 527, 42,084KiB
- Reads Requeued: 0 Writes Requeued: 0
- Reads Completed: 0, 0KiB Writes Completed: 527, 42,084KiB
- Read Merges: 0, 0KiB Write Merges: 53, 436KiB
- IO unplugs: 53 Timer unplugs: 1
+ Reads Queued: 0, 0KiB Writes Queued: 580, 42,084KiB
+ Read Dispatches: 0, 0KiB Write Dispatches: 527, 42,084KiB
+ Reads Requeued: 0 Writes Requeued: 0
+ Reads Completed: 0, 0KiB Writes Completed: 527, 42,084KiB
+ Read Merges: 0, 0KiB Write Merges: 53, 436KiB
+ IO unplugs: 53 Timer unplugs: 1
Throughput (R/W): 0KiB/s / 719KiB/s
Events (sdc): 6,592 entries
@@ -2478,29 +2478,29 @@ And run blkparse on the host system using the device name::
8,32 1 0 177.266696560 0 m N cfq1267 put_queue
CPU0 (sdc):
- Reads Queued: 0, 0KiB Writes Queued: 270, 21,708KiB
- Read Dispatches: 59, 2,628KiB Write Dispatches: 495, 39,964KiB
- Reads Requeued: 0 Writes Requeued: 0
- Reads Completed: 90, 2,752KiB Writes Completed: 543, 41,596KiB
- Read Merges: 0, 0KiB Write Merges: 9, 344KiB
- Read depth: 2 Write depth: 2
- IO unplugs: 20 Timer unplugs: 1
+ Reads Queued: 0, 0KiB Writes Queued: 270, 21,708KiB
+ Read Dispatches: 59, 2,628KiB Write Dispatches: 495, 39,964KiB
+ Reads Requeued: 0 Writes Requeued: 0
+ Reads Completed: 90, 2,752KiB Writes Completed: 543, 41,596KiB
+ Read Merges: 0, 0KiB Write Merges: 9, 344KiB
+ Read depth: 2 Write depth: 2
+ IO unplugs: 20 Timer unplugs: 1
CPU1 (sdc):
- Reads Queued: 688, 2,752KiB Writes Queued: 381, 20,652KiB
- Read Dispatches: 31, 124KiB Write Dispatches: 59, 2,396KiB
- Reads Requeued: 0 Writes Requeued: 0
- Reads Completed: 0, 0KiB Writes Completed: 11, 764KiB
- Read Merges: 598, 2,392KiB Write Merges: 88, 448KiB
- Read depth: 2 Write depth: 2
- IO unplugs: 52 Timer unplugs: 0
+ Reads Queued: 688, 2,752KiB Writes Queued: 381, 20,652KiB
+ Read Dispatches: 31, 124KiB Write Dispatches: 59, 2,396KiB
+ Reads Requeued: 0 Writes Requeued: 0
+ Reads Completed: 0, 0KiB Writes Completed: 11, 764KiB
+ Read Merges: 598, 2,392KiB Write Merges: 88, 448KiB
+ Read depth: 2 Write depth: 2
+ IO unplugs: 52 Timer unplugs: 0
Total (sdc):
- Reads Queued: 688, 2,752KiB Writes Queued: 651, 42,360KiB
- Read Dispatches: 90, 2,752KiB Write Dispatches: 554, 42,360KiB
- Reads Requeued: 0 Writes Requeued: 0
- Reads Completed: 90, 2,752KiB Writes Completed: 554, 42,360KiB
- Read Merges: 598, 2,392KiB Write Merges: 97, 792KiB
- IO unplugs: 72 Timer unplugs: 1
+ Reads Queued: 688, 2,752KiB Writes Queued: 651, 42,360KiB
+ Read Dispatches: 90, 2,752KiB Write Dispatches: 554, 42,360KiB
+ Reads Requeued: 0 Writes Requeued: 0
+ Reads Completed: 90, 2,752KiB Writes Completed: 554, 42,360KiB
+ Read Merges: 598, 2,392KiB Write Merges: 97, 792KiB
+ IO unplugs: 72 Timer unplugs: 1
Throughput (R/W): 15KiB/s / 238KiB/s
Events (sdc): 9,301 entries
diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst
index bc09613db7..2b9bccb4a9 100644
--- a/documentation/ref-manual/terms.rst
+++ b/documentation/ref-manual/terms.rst
@@ -226,23 +226,23 @@ universal, the list includes them just in case:
As far as bootloaders are concerned, :term:`Initramfs` and "initrd"
images are still copied to RAM in the same way. That's why most
- most bootloaders refer to :term:`Initramfs` images as "initrd"
- or "init RAM disk".
+ most bootloaders refer to :term:`Initramfs` images as "initrd"
+ or "init RAM disk".
This kind of mechanism is typically used for two reasons:
- For booting the same kernel binary on multiple systems requiring
different device drivers. The :term:`Initramfs` image is then customized
- for each type of system, to include the specific kernel modules
+ for each type of system, to include the specific kernel modules
necessary to access the final root filesystem. This technique
- is used on all GNU / Linux distributions for desktops and servers.
+ is used on all GNU / Linux distributions for desktops and servers.
- For booting faster. As the root filesystem is extracted into RAM,
accessing the first user-space applications is very fast, compared
to having to initialize a block device, to access multiple blocks
from it, and to go through a filesystem having its own overhead.
For example, this allows to display a splashscreen very early,
- and to later take care of mounting the final root filesystem and
+ and to later take care of mounting the final root filesystem and
loading less time-critical kernel drivers.
This cpio archive can either be loaded to RAM by the bootloader,
diff --git a/documentation/sdk-manual/working-projects.rst b/documentation/sdk-manual/working-projects.rst
index 7483d51fa3..296d7d8464 100644
--- a/documentation/sdk-manual/working-projects.rst
+++ b/documentation/sdk-manual/working-projects.rst
@@ -286,14 +286,14 @@ example:
# CC=i586-poky-linux-gcc -m32 -march=i586 --sysroot=/opt/poky/2.5/sysroots/i586-poky-linux
# CC="gcc"
all: main.o module.o
- ${CC} main.o module.o -o target_bin
+ ${CC} main.o module.o -o target_bin
main.o: main.c module.h
- ${CC} -I . -c main.c
+ ${CC} -I . -c main.c
module.o: module.c
- module.h ${CC} -I . -c module.c
+ module.h ${CC} -I . -c module.c
clean:
- rm -rf *.o
- rm target_bin
+ rm -rf *.o
+ rm target_bin
4. *Make the Project:* Use the ``make`` command to create the binary
output file. Because variables are commented out in the Makefile, the
--
2.34.1
^ permalink raw reply related [flat|nested] 10+ messages in thread
end of thread, other threads:[~2024-04-14 18:20 UTC | newest]
Thread overview: 10+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2024-04-14 18:20 [kirkstone][PATCH 0/9] documentation backports michael.opdenacker
2024-04-14 18:20 ` [kirkstone][PATCH 1/9] release-notes-4.0.17: reorder CVEs michael.opdenacker
2024-04-14 18:20 ` [kirkstone][PATCH 2/9] docs: conf.py: properly escape backslashes for latex_elements michael.opdenacker
2024-04-14 18:20 ` [kirkstone][PATCH 3/9] manuals: refer to new yocto-patches mailing list wherever appropriate michael.opdenacker
2024-04-14 18:20 ` [kirkstone][PATCH 4/9] manuals: fix duplicate "stylecheck" target michael.opdenacker
2024-04-14 18:20 ` [kirkstone][PATCH 5/9] manuals: add initial sphinx-lint support michael.opdenacker
2024-04-14 18:20 ` [kirkstone][PATCH 6/9] manuals: fix trailing spaces michael.opdenacker
2024-04-14 18:20 ` [kirkstone][PATCH 7/9] manuals: fix incorrect double backticks michael.opdenacker
2024-04-14 18:20 ` [kirkstone][PATCH 8/9] kernel-dev: join mkdir commands with -p michael.opdenacker
2024-04-14 18:20 ` [kirkstone][PATCH 9/9] manuals: remove tab characters michael.opdenacker
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).