Commit Graph

33 Commits

Author SHA1 Message Date
Antonin Godard
9b6d0d6e5a Add a new "Security" section
The current security-related documentation is a bit hard to find and
hidden within the development manual. However these are processes that
are not part of a development task but is rather a vulnerability
reporting process.

Create a new "Security" section in the documentation to gather this
information. This will be directly visible in the sidebar when opening
the documentation.

Split the previous security-subjects.rst document into 2 documents:

- security-team.rst: defines the roles of the security teams and its
  members.

- reporting-vulnerabilities.rst: guide to report vulnerabilities to the
  security team.

The plan is to backport these documents to active releases. As a
consequence, this section should be free of instructions and information
that only make sense for a specific release. It should _not_ contain
documents on how to enable security features with Yocto on target
devices, this is unrelated and can be left in the development manual
(for example: dev-manual/vulnerabilities.rst to deal with CVEs).

(From yocto-docs rev: 80556704f8b60b5bf903da497909cfda7dd1b28b)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 81e14ca2d5cff9e2104c556655144b069633790c)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2026-01-26 09:41:30 +00:00
Trevor Woerner
a2f2212436 sphinx-lint: unbalanced inline literal markup
Fix as many instances of unbalanced-inline-literals-delimiters as reported by
'make sphinx-lint' as possible. Sphinx and/or its linter seem to get tripped
up randomly when references contain links to heading which contain literals
enclosed in double-back-tics, and not all of them can be "fixed" to pass both
building and linting.

(From yocto-docs rev: 0ba5429953dfa0cdc983ed13ddd06351116031c7)

Signed-off-by: Trevor Woerner <twoerner@gmail.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2025-05-27 09:38:57 -07:00
Antonin Godard
8d694594e1 conf.py: rename :cve: role to :cve_nist:
Newer versions of Sphinx already define a :cve: role that points to
cve.org, instead of the role we defined in conf.py that points to
nvd.nist.gov.

Rename our role to :cve_nist: to avoid warnings (treated as errors).
This is also backwards compatible, meaning we can build the doc with an
older Sphinx if needed.

The file were automatically replaced with following command:

find . -name '*.rst' -exec sed -i 's/:cve:/:cve_nist:/g' {} \+

Cherry pick:

* remove changes to release-notes-5.1.rst, does not exist on this branch.

* release-notes-5.0.4.rst: apply the command to this file as it was
  treated previously.

Suggested-By: Quentin Schulz <quentin.schulz@cherry.de>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 5b86879b3b5f3c51bc7fa5dd2848cf1153a22242)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 15fa3b7e85dde50d7236c1738ad607531cc654b8)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-11-09 05:53:57 -08:00
Michael Opdenacker
f4fc8e6232 release-notes-4.3: fix spacing
This fixes an ugly formatting issue in the HTML output

(From yocto-docs rev: 79530aeb97976b9a63bf04ed247f98061fc9d737)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-02-05 14:30:34 +00:00
Lee Chee Yang
dc2f087dc9 release-notes-4.3: add Repositories / Downloads section
Add Repositories/Downloads Section for 4.3 release notes.

(From yocto-docs rev: d8ee569524663ac738cb71ff2fd8cca49d0acf6c)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-20 10:59:40 +00:00
Michael Opdenacker
6806bd2349 migration-guides: fix empty sections
(From yocto-docs rev: 897d5017eae6b3af2d5d489fc4e0915d9ce21458)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:28 +00:00
Paul Eggleton
042610fe4a release-notes-4.3: feature additions
Some additional feature items from combing through commits (not 100%
complete yet.)

(From yocto-docs rev: 05c13cf0964a892a38531e3cfac68687278ee601)

Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:28 +00:00
Paul Eggleton
610a4030ba release-notes-4.3: move new classes to Rust section
These are both Rust-related, let's move them the Rust section since they
are more notable there.

(From yocto-docs rev: 0510136abf8868d510125bae7f4096342bb94ec0)

Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:28 +00:00
Paul Eggleton
10e7cdea5b release-notes-4.3: remove the Distribution section
This section doesn't make a lot of sense to separate out. The SPDX
change is now no longer Poky-specific, and the poky-altcfg usrmerge
change is not really notable given that poky-altcfg is not widely used
outside of our testing and also itself selects systemd as INIT_MANAGER
and thus requires usrmerge anyway (as noted elsewhere).

(From yocto-docs rev: 234379c81db810c1fc3b860d51a59c200e97b2ca)

Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:28 +00:00
Paul Eggleton
dee87ea100 release-notes-4.3: add CVEs, recipe upgrades, license changes, contributors
Add the list of CVE fixes, recipe upgrades (from commits since layer
index version comparison not currently working), license changes and
contributor list.

(From yocto-docs rev: 32bc3d603894ddefb4766fdf4e10442f1aa75216)

Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:28 +00:00
Paul Eggleton
268710be0a release-notes-4.3: tweaks to existing text
A few grammar tweaks.

(From yocto-docs rev: a3e1258be27a08147b062603bd1b6526b26e9516)

Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:28 +00:00
Paul Eggleton
66fa00b224 release-notes-4.3: fix some typos
(From yocto-docs rev: 3c98d2a1bc023aed75261ed7f4e18977b587d2f0)

Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:27 +00:00
Ross Burton
7d6a77ce37 migration-guides: git recipes reword
(From yocto-docs rev: 9ef7cfd47a53ed45f3d0db8534a42cefbfdf63b3)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:27 +00:00
Ross Burton
553256bc8b migration-guides: packaging changes
(From yocto-docs rev: 7558c99f50f4d96e12299a5b3c1059a71281a475)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:27 +00:00
Ross Burton
d95d236add migration-guides: add BitBake changes
(From yocto-docs rev: c719d78cc9d7fb5092d2f5d0285b3eea9ad8acfe)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:27 +00:00
Ross Burton
589c1d85dc migration-guides: add utility notes
(From yocto-docs rev: ba0dcf57944058d9d5f2f791d463c72098c49561)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:27 +00:00
Ross Burton
9e10ca8159 migration-guides: add testing notes
(From yocto-docs rev: cd71d0406c96b44cc872f9eb4c8604bcdd62fed6)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:27 +00:00
Ross Burton
8ceb2bf960 migration-guides: enabling SPDX only for Poky, not a global default
(From yocto-docs rev: fae0b4af717602d04e06d8619389d6b50e0e8e2d)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:27 +00:00
Ross Burton
bb54a9a7dd migration-guides: remove SERIAL_CONSOLES_CHECK
(From yocto-docs rev: 364f8c17ba380107b2d837e17403307c3e04477c)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:27 +00:00
Ross Burton
8f860dc46c migration-guides: add kernel notes
(From yocto-docs rev: 45b67c5a37d560738037478b28cb7eb3d2f8e966)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:27 +00:00
Ross Burton
54d900ab6d migration-guides: mention CDN
(From yocto-docs rev: b7efe7984f9bd62891dc72a6763a6a5935454fdf)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:27 +00:00
Ross Burton
d2ca69cbbf migration-guides: mention LLVM 17
(From yocto-docs rev: 64099ca9b89dd74df7b3a6a287b95a5a317cf916)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:27 +00:00
Michael Opdenacker
e80a5cb66d migration-guides: further updates for release 4.3
(From yocto-docs rev: fcd7490afba8e70740a2d4c17f759bf3e330e88a)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-06 22:52:27 +00:00
Michael Opdenacker
f9ddf08ffd migration-guides: further updates for 4.3
(From yocto-docs rev: 3a4d172f0d5668f3c6527bd80d1dad7831e72e89)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-10-30 11:11:17 +00:00
Michael Opdenacker
aa576a80d1 migration-guides: updates for 4.3
(From yocto-docs rev: a2d79ed745df6fe243e6c5e1001d406001c0d3a7)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Paul Eggleton <bluelightning@bluelightning.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-10-30 11:11:17 +00:00
Ross Burton
6e7bf979f2 manuals: document LICENSE_FLAGS_DETAILS
(From yocto-docs rev: 299c9b295a8476abdb32fba01ac2f45efacea6f1)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-09-19 15:57:35 +01:00
Richard Purdie
516d490aef migration-guides: add notes on FILE_LAYERNAME
(From yocto-docs rev: 3cc9f7a14815698c08f47ef5fe8c731b2c2ecf84)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-06-24 12:23:01 +01:00
Michael Opdenacker
c056757ca5 migration-guides: release-notes-4.3: update documentation notes
(From yocto-docs rev: 2d10b7806d52e68df1bc2b6cfd5d6e53e0cd245d)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-06-16 17:31:06 +01:00
Michael Opdenacker
af5cb21d9f migration-guides: update 4.3 release notes
(From yocto-docs rev: ad3ba5c576011e31f71a39c9138f8bd67b3c444f)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-05-26 17:32:51 +01:00
Michael Opdenacker
d807d0f1ea migration-guides: release-notes-4.3: add stub section for documentation changes
(From yocto-docs rev: 91ce841fa166d68448fa26b68a199de020ff18ac)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-05-26 17:32:50 +01:00
Michael Opdenacker
ce7a814b3b ref-manual: document FIT_ADDRESS_CELLS
(From yocto-docs rev: 81ee2e82a5bd0b7f1cb910bf266ceb808c05bba9)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Jamin Lin <jamin_lin@aspeedtech.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-05-06 09:38:58 +01:00
Richard Purdie
2347121381 migration/release-notes-4.3: Add extra notes
(From yocto-docs rev: c365f3d02ed880d4cd3f7970094249780d443b2f)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-05-06 09:38:58 +01:00
Michael Opdenacker
dc7a4f0036 migration-guides: start of 4.3 migration and release notes
From notes from Richard Purdie

(From yocto-docs rev: 62fcaabd06558669034e8732b8d22a9c46e36cf2)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: richard.purdie@linuxfoundation.org
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-05-06 09:38:58 +01:00