From dfd03ab505db81159f56640bf3fe44fc872ce4a8 Mon Sep 17 00:00:00 2001
From: Andrei Gherzan <andrei.gherzan@huawei.com>
Date: Wed, 20 Apr 2022 12:29:29 +0200
Subject: [PATCH] docs: Document the Yocto version Oniro is based on
Fixes https://gitlab.eclipse.org/eclipse/oniro-core/oniro/-/issues/442
Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>
---
docs/definitions.rst | 2 ++
docs/hardware-support/adding-hardware-support.rst | 4 ++--
docs/oniro-quick-build.rst | 2 +-
docs/repo-workspace.rst | 2 +-
docs/yocto-build-system/oniro-build-arch.rst | 12 ++++++++++++
5 files changed, 18 insertions(+), 4 deletions(-)
diff --git a/docs/definitions.rst b/docs/definitions.rst
index 140ab22a..c4d501f1 100644
--- a/docs/definitions.rst
+++ b/docs/definitions.rst
@@ -2,3 +2,5 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
.. |main_project_name| replace:: Oniro Project
+.. |yocto_version| replace:: kirkstone
+
diff --git a/docs/hardware-support/adding-hardware-support.rst b/docs/hardware-support/adding-hardware-support.rst
index 7844c168..c9f8d8af 100644
--- a/docs/hardware-support/adding-hardware-support.rst
+++ b/docs/hardware-support/adding-hardware-support.rst
@@ -34,7 +34,7 @@ Add Required meta-layers
************************
Oniro flavours configuration templates (stored in the `flavours
-<https://gitlab.eclipse.org/eclipse/oniro-core/oniro/-/tree/kirkstone/flavours>`_
+<https://gitlab.eclipse.org/eclipse/oniro-core/oniro/-/tree/|yocto_version|/flavours>`_
`oniro <https://gitlab.eclipse.org/eclipse/oniro-core/oniro>`_ repository
subdirectory) consist of the following files:
@@ -53,7 +53,7 @@ subdirectory) consist of the following files:
|main_project_name| build system uses ***repo*** tool for cloning required meta-layers
into appropriate build directory structure (see :ref:`Setting up a repo workspace <RepoWorkspace>`).
-To include a new layer, it has to be added in two places of the `oniro repository <https://gitlab.eclipse.org/eclipse/oniro-core/oniro/-/tree/kirkstone/manifests>`_:
+To include a new layer, it has to be added in two places of the `oniro repository <https://gitlab.eclipse.org/eclipse/oniro-core/oniro/-/tree/|yocto_version|/manifests>`_:
- The manifest file
- The flavours ``bblayers.conf.sample`` file
diff --git a/docs/oniro-quick-build.rst b/docs/oniro-quick-build.rst
index 3d107ef4..08bb0f49 100644
--- a/docs/oniro-quick-build.rst
+++ b/docs/oniro-quick-build.rst
@@ -52,7 +52,7 @@ Initialize a repo workspace and clone all required repositories:
.. code-block:: console
$ mkdir oniroproject; cd oniroproject
- $ repo init -u https://gitlab.eclipse.org/eclipse/oniro-core/oniro.git -b kirkstone
+ $ repo init -u https://gitlab.eclipse.org/eclipse/oniro-core/oniro.git -b |yocto_version|
$ repo sync --no-clone-bundle
Building an Oniro image
diff --git a/docs/repo-workspace.rst b/docs/repo-workspace.rst
index b7c2b7e4..6db20dbc 100644
--- a/docs/repo-workspace.rst
+++ b/docs/repo-workspace.rst
@@ -109,7 +109,7 @@ This will bring in all the needed sources for building |main_project_name|:
.. code-block:: console
$ mkdir oniroproject; cd oniroproject
- $ repo init -u https://gitlab.eclipse.org/eclipse/oniro-core/oniro.git -b kirkstone
+ $ repo init -u https://gitlab.eclipse.org/eclipse/oniro-core/oniro.git -b |yocto_version|
$ repo sync --no-clone-bundle
Workspace Structure
diff --git a/docs/yocto-build-system/oniro-build-arch.rst b/docs/yocto-build-system/oniro-build-arch.rst
index bd825fdd..332894e3 100644
--- a/docs/yocto-build-system/oniro-build-arch.rst
+++ b/docs/yocto-build-system/oniro-build-arch.rst
@@ -36,4 +36,16 @@ ranging from RTOSes to Linux.
required for compiling |main_project_name| images. The architecture supports plugging
various kernels.
+One of the core aims of |main_project_name| is to provide a stable foundation
+for product development. In doing so, the project tries its best to align all
+the included components to their respective LTS (long-term support) versions.
+The build system is one of the core components used in Oniro and its version
+adheres to the same principle.
+
+The current version of the projects uses ``|yocto_version|`` version of Yocto
+project, the build system of choice in |main_project_name|. This ensures that
+all the Yocto layers brought in are either on their respective
+``|yocto_version|`` branch/version or, in the absence of that, on a
+``|yocto_version|-compatible`` branch/version.
+
.. image:: assets/oniro-arch.png
--
GitLab