diff --git a/docs/definitions.rst b/docs/definitions.rst index 140ab22a067334040061bd8fcd2cd406aec3555e..c4d501f12ca10a3d1015c28e3093b0c764949367 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 7844c1682aaf426696c618d89d3a54fdcecc482e..c9f8d8afd788c60667f3e677906b19977a2ed475 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 3d107ef460cda985ecf0ec3283670cb6cb6765cf..08bb0f4982644fccf364d7e45ea6e084f0dae435 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 b7c2b7e41f9786dcff0b3859e3dea056ff7bd13d..6db20dbc9e8bf6d24fd636dd5a4fcc63abdb83bd 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 bd825fdd9f7f9a0dd769f8e45d7ca1b96cd7f34d..332894e35d8988b103d29505d6bc57778c0c909e 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