Commit Graph

15 Commits

Author SHA1 Message Date
Antonin Godard
7748c7aa32 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' {} \+

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-11-07 10:12:23 +00:00
Niko Mauno
bf4f76d4d1 docs: Replace VOLATILE_TMP_DIR with FILESYSTEM_PERMS_TABLES
The VOLATILE_TMP_DIR variable was removed and it's functionality
replaced with a FILESYSTEM_PERMS_TABLES entry in
https://git.yoctoproject.org/poky/commit/?id=2f46b6f27dfa3a9d5ad177900fcecfe64c3536f1
("bitbake.conf: drop VOLATILE_TMP_DIR, use FILESYSTEM_PERMS_TABLES instead")

(From yocto-docs rev: 1ef0eabaa07cc39075a040b99a5c11567d745408)

Signed-off-by: Niko Mauno <niko.mauno@vaisala.com>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-10-23 12:28:40 +01:00
Michael Opdenacker
fed404fca0 manuals: fix trailing spaces
Fixing errors reported by "make sphinx-lint"

(From yocto-docs rev: ef6b650c31c4320314564bb85a45eebde3fd98c1)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-04-08 14:36:38 +01:00
Michael Opdenacker
9323f4160d migration-guides: use new cve_mitre macro
(From yocto-docs rev: 9dc21e807e76c5ea8429ac31b57ad7b352fbaa71)

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
Lee Chee Yang
e7f8590844 release-notes-4.2: update known issues and Repositories/Downloads
(From yocto-docs rev: 3f5897c5909b8b9b0e2f9d1f1d541c4a8a4d89da)

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-05-26 17:32:50 +01:00
Michael Opdenacker
85bfe72efe migration-guides: release-notes-4.2: add doc improvement highlights
(From yocto-docs rev: 66b5f10bf0747b6ae0a8fbb05103e2f1070b6474)

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
Lee Chee Yang
c4d933a347 release-notes-4.2: remove/merge duplicates entries
(From yocto-docs rev: 6e4b1af0fed2b59909ac9db1be2aaf3e3b542b0c)

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-05-03 10:00:32 +01:00
Michael Opdenacker
7f39a583e7 migration-guides: fixes and improvements to 4.2 release notes
- Remove empty subsections (detailed elsewhere)
- Fix bullet list syntax (missing leading empty line)
- Fix a few CVE URLs
- Add some references
- Minor font and case fixes

(From yocto-docs rev: ec63abf8b67458ad9f8d8942e0c327d3de93eef9)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-04-28 14:46:17 +01:00
Michael Opdenacker
9b6a25606e manuals: document SPDX_CUSTOM_ANNOTATION_VARS
(From yocto-docs rev: 5811f4eb3e73aa5f8ca90e40ec6559a6d4d58fa3)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Saul Wold <Saul.Wold@windriver.com>
CC: Joshua Watt <JPEWhacker@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-04-28 14:46:17 +01:00
Lee Chee Yang
405feecef8 release-notes-4.2: update RC3 changes
also fix typo for CVE-2023-24532.

(From yocto-docs rev: daafb70e6d60fd7d00c8de736eca2c430db77ee8)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-04-26 15:59:47 +01:00
Paul Eggleton
63bd5762b4 release-notes-4.2: add release notes
Add new features, upgrades, CVEs, contributors and license changes
based upon combing through the commits in the release. I haven't yet
noted any known issues.

Note: I had to add the upgrades list from the commits rather than from
the layer index this time (as the branch comparison feature is
unfortunately broken there at the moment), thus the format is a little
different.

(From yocto-docs rev: 4d6807e34adf5d92d9b6e5852736443a867c78fa)

Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-04-22 10:42:54 +01:00
Paul Eggleton
8242bd30de migration-guides: Add coverage of addpylib directive
To complement what I am adding to the BitBake reference manual, add a
section in the 4.2 migration guide, a reference in the structure section
of the reference manual (where we talk about meta/lib) and adjust the
release notes item to be a little more concise.

(From yocto-docs rev: 0903e82a9da263c6d64aead03407eb377eb5bbfe)

Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-04-22 10:42:54 +01:00
Michael Opdenacker
00d9f298b0 migration-guides: update 4.2 migration and release notes
(From yocto-docs rev: 3aac9f8b57434f3852a78915c326074252177515)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Frederic Martinsons <frederic.martinsons@gmail.com>
CC: Marta Rybczynska <rybczynska@gmail.com>
CC: Paul Eggleton <paul.eggleton@linux.microsoft.com>
CC: Alex Kiernan <alex.kiernan@gmail.com>
CC: Alexis Lothoré <alexis.lothore@bootlin.com
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-04-13 11:59:58 +01:00
Michael Opdenacker
46e3d2aefc migration-guides: fix 4.2 migration note issues
- Eliminate this warning:
  WARNING: Title underline too short.
- Remove a leftover patch file

(From yocto-docs rev: 15f1f9b234ba81177ff5fafdb3d42c002daffa56)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-01-06 17:39:09 +00:00
Michael Opdenacker
70126f4f51 manuals: prepare 4.2 migration notes
(From yocto-docs rev: 9276628507233aef554450c807d8456a0eb00225)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-18 10:41:21 +00:00