Commit Graph

14 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
Paul Eggleton
86b1247db4 release-notes-4.1: fix some CVE links
The "(ignored)" suffixes were included in the link value which broke the
link.

(From yocto-docs rev: bff0fb0e39f69101f036ddbc27a82c15047bdbcd)

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
8b1909aa6f manuals: simplify references to classes
Now that .bbclass is removed from class section titles.
We can now have, for example, :ref:`ref-classes-insane`
instead of :ref:`insane <ref-classes-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 <michael.opdenacker@bootlin.com>
Suggested-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-01-06 17:39:09 +00:00
Michael Opdenacker
eb5042210c manuals: create references to buildtools
On the side, also simplify a reference to the section describing them.

(From yocto-docs rev: 0c13a7f9ccee4ddc9c6034d03f47625a09598cec)

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
Michael Opdenacker
8b812b29c4 manuals: add missing SPDX license header to source files
(From yocto-docs rev: 86737cc4583f1ef43bda10033c801329ba0c8b81)

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
Michael Opdenacker
f417d3274c manuals: add missing references to variables
[YOCTO #14508]
(From yocto-docs rev: 7878a21be8fb6c7a1ab88ae44aa5f7bf0079391a)

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
Michael Opdenacker
55621c31f1 manuals: add missing references to classes
Sometimes fixing line length in modified paragraphs too.

[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 885b60f5540849bf19240a01a77efce1d1b5d9f0)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-01 19:20:29 +00:00
Michael Opdenacker
40df2b19bd release-notes: use oe_git and yocto_git macros
As in the rest of the manuals; this is more future proof than using
hard coded URLs.

While doing this, also replacing https://git.yoctoproject.org/git/<repo>
links (used by mistake instead of https://git.yoctoproject.org/<repo>)
by :yocto_git:`/repo`.

(From yocto-docs rev: ac844062400a7bf4732ea6ee639a478b1b77b83e)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-11-10 22:12:56 +00:00
Lee Chee Yang
5724847549 migration-guides/release-notes-4.1.rst: update Repositories / Downloads
(From yocto-docs rev: 8e0841c3418caa227c66a60327db09dfbe72054a)

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>
2022-10-25 13:55:27 +01:00
Lee Chee Yang
56e3989b89 migration-guides/release-notes-4.1.rst: update Repositories / Downloads
(From yocto-docs rev: 99dac0ecc497d50be652a47c8a2ce8855975e360)

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>
2022-10-25 13:41:36 +01:00
Takayasu Ito
95c802b0be release-notes-4.1.rst remove bitbake-layers subcommand argument
(From yocto-docs rev: 0f088df1027b38a47f4161fe0910150ff42c1861)

Signed-off-by: Takayasu Ito <ito@lineo.co.jp>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-21 12:23:50 +01:00
Ross Burton
43cc9a16c1 migration-guides/release-notes-4.1.rst: add more known issues
Clarfify the eSDK issue, and document the externalsrc issue.

(From yocto-docs rev: 25cbbe19c935293e0549d89b6716a0fae229113c)

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>
2022-10-19 17:32:57 +01:00
Ross Burton
2f9472efbc migration-guides: add known issues for 4.1
(From yocto-docs rev: 34ad768a05d6ba87aab64f0aa85e63d4233e0696)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-19 17:32:57 +01:00
Paul Eggleton
a0fbaf259c Add 4.1 migration guide & release notes
This currently does not include known issues or download information.

(From yocto-docs rev: a5c991235e2c063a065d610b3d2a96f5ac534a01)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-19 17:32:57 +01:00