[PATCH 2/2] manuals: add "LTS" term

michael.opdenacker
2023-03-21T17:24:38Z

From: Michael Opdenacker <michael.opdenacker@bootlin.com>

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
documentation/dev-manual/securing-images.rst | 2 +-
.../migration-guides/release-notes-4.0.1.rst | 2 +-
documentation/ref-manual/release-process.rst | 18 +++++++++---------
documentation/ref-manual/terms.rst | 6 ++++++
4 files changed, 17 insertions(+), 11 deletions(-)

diff --git a/documentation/dev-manual/securing-images.rst b/documentation/dev-manual/securing-images.rst
index 6a9223c19c..e5791d3d6d 100644
--- a/documentation/dev-manual/securing-images.rst
+++ b/documentation/dev-manual/securing-images.rst
@@ -68,7 +68,7 @@ more secure:

- Regularly update your version of Poky and OE-Core from their upstream
developers, e.g. to apply updates and security fixes from stable
- and LTS branches.
+ and :term:`LTS` branches.

- Ensure you remove or disable debugging functionality before producing
the final image. For information on how to do this, see the
diff --git a/documentation/migration-guides/release-notes-4.0.1.rst b/documentation/migration-guides/release-notes-4.0.1.rst
index c46142a08a..5529f71c6f 100644
--- a/documentation/migration-guides/release-notes-4.0.1.rst
+++ b/documentation/migration-guides/release-notes-4.0.1.rst
@@ -86,7 +86,7 @@ Fixes in 4.0.1
- migration-3.4: add missing entry on :term:`EXTRA_USERS_PARAMS`
- migration-guides: add release notes for 4.0
- migration-guides: complete migration guide for 4.0
-- migration-guides: release-notes-4.0: mention LTS release
+- migration-guides: release-notes-4.0: mention :term:`LTS` release
- migration-guides: release-notes-4.0: update 'Repositories / Downloads' section
- migration-guides: stop including documents with ".. include"
- musl: Fix build when usrmerge distro feature is enabled
diff --git a/documentation/ref-manual/release-process.rst b/documentation/ref-manual/release-process.rst
index 8b70a08f04..2cbf0d3b8c 100644
--- a/documentation/ref-manual/release-process.rst
+++ b/documentation/ref-manual/release-process.rst
@@ -92,26 +92,26 @@ Long Term Support Releases

While stable releases are supported for a duration of seven months,
some specific ones are now supported for a longer period by the Yocto
-Project, and are called Long Term Support (LTS) releases.
+Project, and are called Long Term Support (:term:`LTS`) releases.

This started with version 3.1 ("Dunfell"), released in April 2020, that
-the project committed to supporting until the next LTS release was out.
-This next LTS release, version 4.0 ("Kirkstone"), was released in May 2022
+the project committed to supporting until the next :term:`LTS` release was out.
+This next :term:`LTS` release, version 4.0 ("Kirkstone"), was released in May 2022
and offered with two years of support too.

However, as an experiment, support for "Dunfell" was extended to four years, until
April 2024, therefore offering more stability to projects and leaving more time
-to upgrade to the latest LTS release. The project hasn't made any commitment to
+to upgrade to the latest :term:`LTS` release. The project hasn't made any commitment to
extending "Kirkstone" support too, as this will also depend on available funding
for such an effort.

-When significant issues are found, LTS releases allow to publish
+When significant issues are found, :term:`LTS` releases allow to publish
fixes not only for the current stable release, but also to the
-LTS releases that are still supported. Older stable releases which
+:term:`LTS` releases that are still supported. Older stable releases which
have reached their End of Life (EOL) won't receive such updates.

See :yocto_wiki:`/Stable_Release_and_LTS` for details about the management
-of stable and LTS releases.
+of stable and :term:`LTS` releases.

.. image:: svg/releases.*
:width: 100%
@@ -119,9 +119,9 @@ of stable and LTS releases.
.. note::

In some circumstances, a layer can be created by the community in order to
- add a specific feature or support a new version of some package for an LTS
+ add a specific feature or support a new version of some package for an :term:`LTS`
release. This is called a "mixin" layer. These are thin and specific
- purpose layers which can be stacked with an LTS release to "mix" a specific
+ purpose layers which can be stacked with an :term:`LTS` release to "mix" a specific
feature into that build. These are created on an as-needed basis and
maintained by the people who need them.

diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst
index ec447d35d2..5a7363acad 100644
--- a/documentation/ref-manual/terms.rst
+++ b/documentation/ref-manual/terms.rst
@@ -227,6 +227,12 @@ universal, the list includes them just in case:
Layers`" section in the Yocto Project Board Support Packages (BSP)
Developer's Guide.

+ :term:`LTS`
+ This term means "Long Term Support", and in the context of the Yocto
+ Project, it corresponds to selected stable releases for which bug and
+ security fixes are provided for at least two years. See
+ ":doc:`/ref-manual/release-process`" for details.
+
:term:`Metadata`
A key element of the Yocto Project is the Metadata that
is used to construct a Linux distribution and is contained in the
--
2.34.1