diff --git a/docs/allscenarios-quick-build.rst b/docs/allscenarios-quick-build.rst
index 28041d4ab8336f2dcb58fbba71e55cc383697602..e0c363627f6208ee47a456bc1296908b20062416 100644
--- a/docs/allscenarios-quick-build.rst
+++ b/docs/allscenarios-quick-build.rst
@@ -2,17 +2,19 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
+.. include:: definitions.rst
+
.. _AllScenariOSQuickBuild:
-All Scenarios OS - Quick Build
-##############################
+|main_project_name| - Quick Build
+#################################
-This section will guide you to building your first All Scenarios OS image targeting
+This section will guide you to building your first |main_project_name| image targeting
a supported reference hardware. It will also provide the steps for flashing and
booting such an image.
The steps below will focus on a Qemu-based target. If you want to get a feeling
-of All Scenarios OS on a real hardware, checkout the :ref:`Avenger96 support page
+of |main_project_name| on a real hardware, checkout the :ref:`Avenger96 support page
<SupportedBoardAvenger96>`.
.. contents::
@@ -64,7 +66,7 @@ cloned using the repo tool. See above.
.. Note::
- Depending on the configuration type, a single All Scenarios OS build could
+ Depending on the configuration type, a single |main_project_name| build could
use around 100GB of disk space for downloads, temporary files, and build artifacts combined.
Initialize the build directory and run a build:
@@ -74,8 +76,8 @@ Initialize the build directory and run a build:
$ TEMPLATECONF=../sources/meta-ohos/flavours/linux . ./sources/poky/oe-init-build-env build-ohos-linux
$ MACHINE=qemux86-64 bitbake allscenarios-image-base
-Booting a Qemu X86-64 target with a All Scenarios OS image
-**********************************************************
+Booting a Qemu X86-64 target with a |main_project_name| image
+*************************************************************
Once the image is built, you can run a Qemu X86-64 instance using the provided script wrapper as follows:
diff --git a/docs/blueprints/doorlock.rst b/docs/blueprints/doorlock.rst
index 564a5418327934b1c26611cafe0f70593a1abf1b..d78507c62bb7552dcac0dd2552b2789625b25a4f 100644
--- a/docs/blueprints/doorlock.rst
+++ b/docs/blueprints/doorlock.rst
@@ -2,6 +2,8 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
+.. include:: ../definitions.rst
+
##################
DoorLock Blueprint
##################
@@ -132,7 +134,7 @@ The Software
Get sources
===========
#.
- Get All Scenarios OS sources as described in the :ref:`documentation <AllScenariOSQuickBuild>`.
+ Get |main_project_name| sources as described in the :ref:`documentation <AllScenariOSQuickBuild>`.
#.
If you already have sources cloned, update them to the most recent revision
diff --git a/docs/blueprints/index.rst b/docs/blueprints/index.rst
index 25f61e6097f5d94c073331fe1064f8ac0b7fe075..d1251f4a5f2009e9eb36d70dbc2ab64135775d1b 100644
--- a/docs/blueprints/index.rst
+++ b/docs/blueprints/index.rst
@@ -2,15 +2,17 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
-All Scenarios OS Blueprints
-###########################
+.. include:: ../definitions.rst
+
+|main_project_name| Blueprints
+##############################
Overview
********
-All Scenarios OS integrates its various components into a representative use-case called a `Blueprint`. A blueprint shows off the OS capabilities and best practices in building software-based products.
+|main_project_name| integrates its various components into a representative use-case called a `Blueprint`. A blueprint shows off the OS capabilities and best practices in building software-based products.
-To this end, blueprints are a way to distill real-world products into a ``minimum viable product`` to demonstrate how partners and users may adopt All Scenarios OS securely in their own products.
+To this end, blueprints are a way to distill real-world products into a ``minimum viable product`` to demonstrate how partners and users may adopt |main_project_name| securely in their own products.
What is a Blueprint?
--------------------
@@ -25,7 +27,7 @@ What is a Blueprint?
* Display, e.g., showing useful messages on a display.
* Autonomous communication between two devices over a wireless link.
-#. It is implemented on the closest appropriate reference HW platform from All Scenarios OS.
+#. It is implemented on the closest appropriate reference HW platform from |main_project_name|.
What a Blueprint Isn't?
-----------------------
@@ -36,7 +38,7 @@ What a Blueprint Isn't?
Blueprints
**********
-This section details the available blueprints provided as part of the All Scenarios OS environment.
+This section details the available blueprints provided as part of the |main_project_name| environment.
.. toctree::
:maxdepth: 1
diff --git a/docs/blueprints/smart-panel.rst b/docs/blueprints/smart-panel.rst
index 47ba43513639201d465c8ee51fe863e48bf8aea5..07da16e590fa578e55c4f95c825ec7163cc1fb9f 100644
--- a/docs/blueprints/smart-panel.rst
+++ b/docs/blueprints/smart-panel.rst
@@ -2,6 +2,8 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
+.. include:: ../definitions.rst
+
Smart Panel Blueprint
#####################
@@ -134,7 +136,7 @@ IoT devices
Get sources
***********
#.
- Get All Scenarios OS sources as described in the :ref:`documentation <AllScenariOSQuickBuild>`.
+ Get |main_project_name| sources as described in the :ref:`documentation <AllScenariOSQuickBuild>`.
#.
If you already have sources cloned, update them to the most recent revision
@@ -333,7 +335,7 @@ Flash
Add Bluetooth firmware
----------------------
-Due to licensing details, All Scenarios OS cannot provide the firmware file for
+Due to licensing details, |main_project_name| cannot provide the firmware file for
the on-board Bluetooth controller. However, user may download and install it
manually.
diff --git a/docs/blueprints/touchpanel.rst b/docs/blueprints/touchpanel.rst
index c449eb074798015f4961e0b931d68e632d0438a1..1e71f0d59b8024b0186446174e2358a4ef5b5d82 100644
--- a/docs/blueprints/touchpanel.rst
+++ b/docs/blueprints/touchpanel.rst
@@ -2,6 +2,8 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
+.. include:: ../definitions.rst
+
TouchPanel Blueprint
#####################
@@ -20,7 +22,7 @@ The TouchPanel Blueprint provides support for building a PoC smart touch panel t
Get sources
***********
#.
- Get All Scenarios OS sources as described in the :ref:`documentation <AllScenariOSQuickBuild>`.
+ Get |main_project_name| sources as described in the :ref:`documentation <AllScenariOSQuickBuild>`.
#.
If you already have sources cloned, update them to the most recent revision
diff --git a/docs/blueprints/transparent-gateway.rst b/docs/blueprints/transparent-gateway.rst
index 439d1b576dcb439741f869713c32a5db68898c68..d4f7c254f0a441f8c289b1227418bdd60070107f 100644
--- a/docs/blueprints/transparent-gateway.rst
+++ b/docs/blueprints/transparent-gateway.rst
@@ -2,6 +2,8 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
+.. include:: ../definitions.rst
+
Transparent Gateway Blueprint
#############################
@@ -39,7 +41,7 @@ WiFi Access Point Configuration
In our default WiFi access point configuration, we create an AP on channel 6 in the 2.4 GHz band with WPA2 pre-shared key configuration::
- SSID: "All Scenarios OS WiFi"
+ SSID: "|main_project_name| WiFi"
Passphrase: "12345678".
For more details, the used `hostapd configuration file <https://git.ostc-eu.org/OSTC/OHOS/meta-ohos/-/blob/develop/meta-ohos-blueprints/recipes-connectivity/hostapd/files/hostapd.conf>`_ is the best reference.
@@ -57,7 +59,7 @@ For more details, the used `OpenThread configuration script <https://git.ostc-eu
Get sources
***********
-#. Get All Scenarios OS sources as described in the :ref:`documentation <AllScenariOSQuickBuild>`.
+#. Get |main_project_name| sources as described in the :ref:`documentation <AllScenariOSQuickBuild>`.
#. If you already have sources cloned, update them to the most recent revision.
.. code-block:: bash
diff --git a/docs/blueprints/vending-machine.rst b/docs/blueprints/vending-machine.rst
index aaad8ce451db14a56452735bccb58b082015624e..c3082acebd61165d41ff650477cf2d7ef2b08132 100644
--- a/docs/blueprints/vending-machine.rst
+++ b/docs/blueprints/vending-machine.rst
@@ -2,6 +2,8 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
+.. include:: ../definitions.rst
+
Vending Machine Blueprint
#########################
@@ -12,13 +14,13 @@ Overview
********
The Vending Machine Blueprint provides support for building a PoC smart vending machine
-with components showing the capabilities of the All Scenarios OS build infrastructure to easily
+with components showing the capabilities of the |main_project_name| build infrastructure to easily
build an end-to-end solution using multiple operating systems cooperating inside a product.
Get sources
***********
#.
- Get All Scenarios OS sources as described in the :ref:`documentation <AllScenariOSQuickBuild>`.
+ Get |main_project_name| sources as described in the :ref:`documentation <AllScenariOSQuickBuild>`.
#.
If you already have sources cloned, update them to the most recent revision
diff --git a/docs/build-flavours/build-flavours.rst b/docs/build-flavours/build-flavours.rst
index 9fbf57d77add207788094e03bfe6a27cf7bb721b..b4c932cbe3c283e0e63b2ee465e6c3ff36eb1fc7 100644
--- a/docs/build-flavours/build-flavours.rst
+++ b/docs/build-flavours/build-flavours.rst
@@ -2,12 +2,14 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
+.. include:: ../definitions.rst
+
Overview of Build Flavours
##########################
-All Scenarios OS can be hosted on top of variety of kernels. Currently supported
+|main_project_name| can be hosted on top of variety of kernels. Currently supported
kernels are Linux, Zephyr and FreeRTOS (experimental). The build system
-requires build configuration that is specific to each kernel and All Scenarios OS
+requires build configuration that is specific to each kernel and |main_project_name|
provides all this configuration as build templates. See `Yocto documentation <https://www.yoctoproject.org/docs/current/mega-manual/mega-manual.html#creating-a-custom-template-configuration-directory>`_
for more info about the underlying mechanism.
diff --git a/docs/build-flavours/freertos-flavour.rst b/docs/build-flavours/freertos-flavour.rst
index 34eda856100a06c68e2daac9dcb31971232edb6e..74d17940f935a80b73bf5bdc545ff280277a38c1 100644
--- a/docs/build-flavours/freertos-flavour.rst
+++ b/docs/build-flavours/freertos-flavour.rst
@@ -2,12 +2,14 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
+.. include:: ../definitions.rst
+
.. _FreeRTOS_Kernel:
FreeRTOS Kernel Build Flavour
#############################
-All Scenarios OS FreeRTOS build flavour is based on *freertos* distribution (distro configuration).
+|main_project_name| FreeRTOS build flavour is based on *freertos* distribution (distro configuration).
Supported images:
diff --git a/docs/build-flavours/index.rst b/docs/build-flavours/index.rst
index d0f8a699b512402521b04653b06aae43daa9f8f9..d79c923a5548fcc6e246a927ff115c766ae1f8b9 100644
--- a/docs/build-flavours/index.rst
+++ b/docs/build-flavours/index.rst
@@ -2,10 +2,12 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
-All Scenarios OS Build Flavours
-###############################
+.. include:: ../definitions.rst
-All Scenarios OS provides default build configuration for each supported type of
+|main_project_name| Build Flavours
+##################################
+
+|main_project_name| provides default build configuration for each supported type of
kernels. Each set of such configuration is called a ``flavour``.
.. toctree::
diff --git a/docs/build-flavours/linux-flavour.rst b/docs/build-flavours/linux-flavour.rst
index ae450a10b91c8a9f5f6fc7765240d39635feb992..40638bd249399f792fd9ee4c8a5872afc1e6ca82 100644
--- a/docs/build-flavours/linux-flavour.rst
+++ b/docs/build-flavours/linux-flavour.rst
@@ -2,12 +2,14 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
+.. include:: ../definitions.rst
+
.. _Linux_Kernel:
Linux Kernel Build Flavour
##########################
-All Scenarios OS Linux build flavour is based on *allscenarios-linux* distribution (distro configuration).
+|main_project_name| Linux build flavour is based on *allscenarios-linux* distribution (distro configuration).
Supported images:
diff --git a/docs/build-flavours/zephyr-flavour.rst b/docs/build-flavours/zephyr-flavour.rst
index 7fa21496715d577e6020ff5d7d38ce6ff89d4eb0..d2dc85583b86696f1be1d9fd2f4faa737e0143ac 100644
--- a/docs/build-flavours/zephyr-flavour.rst
+++ b/docs/build-flavours/zephyr-flavour.rst
@@ -2,12 +2,14 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
+.. include:: ../definitions.rst
+
.. _Zephyr_Kernel:
Zephyr Kernel Build Flavour
###########################
-All Scenarios OS Zephyr build flavour is based on *allscenarios-zephyr* distribution (distro configuration).
+|main_project_name| Zephyr build flavour is based on *allscenarios-zephyr* distribution (distro configuration).
Supported images:
diff --git a/docs/ci/machines-and-flavours.rst b/docs/ci/machines-and-flavours.rst
index b00cc3405457817bf59733537cf1f80e9d585cc3..0c2d71a6384725cb4cc7fccaeec8d3650e96630c 100644
--- a/docs/ci/machines-and-flavours.rst
+++ b/docs/ci/machines-and-flavours.rst
@@ -2,6 +2,8 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
+.. include:: ../definitions.rst
+
Machines and Flavours
---------------------
@@ -20,8 +22,8 @@ linux-qemu-x86
This job extends `.build-linux` job from the manifest repository and builds
``allscenarios-image-base-tests`` and ``allscenarios-image-extra-tests`` using
-the Linux flavour of All Scenarios OS and ``MACHINE=qemux86``. This job checks that
-All Scenarios OS software can be built for a basic 32bit x86 virtual machine.
+the Linux flavour of |main_project_name| and ``MACHINE=qemux86``. This job checks that
+|main_project_name| software can be built for a basic 32bit x86 virtual machine.
The cache for this job is publicly available.
@@ -30,8 +32,8 @@ linux-qemu-x86_64
This job extends `.build-linux` job from the manifest repository and builds
``allscenarios-image-base-tests`` and ``allscenarios-image-extra-tests`` using
-the Linux flavour of All Scenarios OS and ``MACHINE=qemux86-64``. This job checks that
-All Scenarios OS software can be built for a basic 64bit x86 virtual machine.
+the Linux flavour of |main_project_name| and ``MACHINE=qemux86-64``. This job checks that
+|main_project_name| software can be built for a basic 64bit x86 virtual machine.
The cache for this job is publicly available.
@@ -40,8 +42,8 @@ linux-seco-intel-b68
This job extends `.build-linux` job from the manifest repository and builds
``allscenarios-image-base-tests`` and ``allscenarios-image-extra-tests`` using
-the Linux flavour of All Scenarios OS and ``MACHINE=seco-intel-b68``. This job
-checks that All Scenarios OS software can be built for the SECO B68 development
+the Linux flavour of |main_project_name| and ``MACHINE=seco-intel-b68``. This job
+checks that |main_project_name| software can be built for the SECO B68 development
board, which contains an Intel x86_64 SoC.
.. note::
@@ -53,8 +55,8 @@ linux-seco-imx8mm-c61
This job extends `.build-linux` job from the manifest repository and builds
``allscenarios-image-base-tests`` and ``allscenarios-image-extra-tests`` using
-the Linux flavour of All Scenarios OS and ``MACHINE=seco-imx8mm-c61``. This job
-checks that All Scenarios OS software can be built for the SECO C61 development
+the Linux flavour of |main_project_name| and ``MACHINE=seco-imx8mm-c61``. This job
+checks that |main_project_name| software can be built for the SECO C61 development
board, which contains the NXP i.MX 8M Mini SoC, which implements 64bit ARMv8
architecture.
@@ -67,8 +69,8 @@ linux-stm32mp1-av96
This job extends `.build-linux` job from the manifest repository and builds
``allscenarios-image-base-tests`` and ``allscenarios-image-extra-tests`` using
-the Linux flavour of All Scenarios OS and ``MACHINE=stm32mp1-av96``. This job checks
-that All Scenarios OS software can be built for the 96Boards Avenger development
+the Linux flavour of |main_project_name| and ``MACHINE=stm32mp1-av96``. This job checks
+that |main_project_name| software can be built for the 96Boards Avenger development
board, which contains the STM32MP157 SoC, which implements 32bit ARMv7
architecture.
@@ -81,8 +83,8 @@ linux-raspberrypi4-64
This job extends `.build-linux` job from the manifest repository and builds
``allscenarios-image-base-tests`` and ``allscenarios-image-extra-tests`` using
-the Linux flavour of All Scenarios OS and ``MACHINE=raspberrypi4-64``. This job
-checks that All Scenarios OS software can be built for the Raspberry Pi 4B
+the Linux flavour of |main_project_name| and ``MACHINE=raspberrypi4-64``. This job
+checks that |main_project_name| software can be built for the Raspberry Pi 4B
development board, which contains the BCM2711 SoC, which implements 64bit ARMv8
architecture.
@@ -94,7 +96,7 @@ zephyr-qemu-x86
...............
This job extends `.build-zephyr` job from the manifest repository and builds
-``zephyr-philosophers`` using the Zephyr flavour of All Scenarios OS and
+``zephyr-philosophers`` using the Zephyr flavour of |main_project_name| and
``MACHINE=qemu-x86``. This job checks that Zephyr can be built for a basic
32bit x86 virtual machine.
@@ -104,7 +106,7 @@ zephyr-qemu-cortex-m3
.....................
This job extends `.build-zephyr` job from the manifest repository and builds
-``zephyr-philosophers`` using the Zephyr flavour of All Scenarios OS and
+``zephyr-philosophers`` using the Zephyr flavour of |main_project_name| and
``MACHINE=qemu-cortex-m3``. This job checks that Zephyr can be built for a
basic 32bit ARM micro-controller virtual machine.
@@ -114,7 +116,7 @@ zephyr-96b-nitrogen
...................
This job extends `.build-zephyr` job from the manifest repository and builds
-``zephyr-philosophers`` using the Zephyr flavour of All Scenarios OS and
+``zephyr-philosophers`` using the Zephyr flavour of |main_project_name| and
``MACHINE=96b-nitrogen``. This job checks that Zephyr can be built for the
96Boards Nitrogen development board, which contains an nRF52832 SoC.
@@ -126,7 +128,7 @@ zephyr-96b-avenger
..................
This job extends `.build-zephyr` job from the manifest repository and builds
-``zephyr-philosophers`` using the Zephyr flavour of All Scenarios OS and
+``zephyr-philosophers`` using the Zephyr flavour of |main_project_name| and
``MACHINE=96b-avenger96``. This job checks that Zephyr can be built for the
96Boards Avenger development board cortex-M3 core, embedded into STM32MP157
SoC.
@@ -139,7 +141,7 @@ zephyr-arduino-nano-33-ble
..........................
This job extends `.build-zephyr` job from the manifest repository and builds
-``zephyr-philosophers`` using the Zephyr flavour of All Scenarios OS and
+``zephyr-philosophers`` using the Zephyr flavour of |main_project_name| and
``MACHINE=arduino-nano-33-ble``. This job checks that Zephyr can be built for the
Arduino Nano 33 BLE development board Cortex-M4 core, embedded into nRF 52840
SoC.
@@ -152,7 +154,7 @@ freertos-armv5
..............
This job extends `.build-freertos` job from the manifest repository and builds
-``freertos-demo`` using the FreeRTOS flavour of All Scenarios OS and
+``freertos-demo`` using the FreeRTOS flavour of |main_project_name| and
``MACHINE=qemuarmv5``. This job checks that FreeRTOS can be built for a basic
32bit ARMv5 micro-controller virtual machine.
diff --git a/docs/definitions.rst b/docs/definitions.rst
new file mode 100644
index 0000000000000000000000000000000000000000..3e6b72e409bcdd977dd79e0e1a280d73fffb9e77
--- /dev/null
+++ b/docs/definitions.rst
@@ -0,0 +1,4 @@
+.. SPDX-FileCopyrightText: Huawei Inc.
+..
+.. SPDX-License-Identifier: CC-BY-4.0
+.. |main_project_name| replace:: All Scenarios OS
diff --git a/docs/hardware-support/adding-hardware-support.rst b/docs/hardware-support/adding-hardware-support.rst
index 324141b17ac3bcca9b1fae8d02b30611f9fddaf1..221028e8965317d91ab92f1e00c6bb2a13cfbcf0 100644
--- a/docs/hardware-support/adding-hardware-support.rst
+++ b/docs/hardware-support/adding-hardware-support.rst
@@ -2,22 +2,24 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
-Adding New Hardware Support in All Scenarios OS
-###############################################
+.. include:: ../definitions.rst
+
+Adding New Hardware Support in |main_project_name|
+##################################################
This section details the addition of new hardware to the supported set in
-All Scenarios OS. It is intended as a checklist for adding new boards to OHOS build
+|main_project_name|. It is intended as a checklist for adding new boards to OHOS build
system.
-Before starting get familiar with All Scenarios OS Contribution Process.
+Before starting get familiar with |main_project_name| Contribution Process.
.. contents::
:depth: 2
-Select All Scenarios OS Flavour
-*******************************
+Select |main_project_name| Flavour
+**********************************
-All Scenarios OS uses a notion of kernel specific flavours:
+|main_project_name| uses a notion of kernel specific flavours:
- Linux flavour
- Zephyr flavour
@@ -47,7 +49,7 @@ directory) consist of the following files:
* - ``local.conf.sample``
- default flavour build configuration
-All Scenarios OS build system uses ***repo*** tool for cloning required meta-layers
+|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:
diff --git a/docs/hardware-support/blueprint-peripherals/index.rst b/docs/hardware-support/blueprint-peripherals/index.rst
index f414d29aff6fae9d0bdb6c63a18430cb647e4a9d..469de3d09847fe4ced44c572716f349230329071 100644
--- a/docs/hardware-support/blueprint-peripherals/index.rst
+++ b/docs/hardware-support/blueprint-peripherals/index.rst
@@ -2,10 +2,12 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
+.. include:: ../../definitions.rst
+
Peripherals used in implementing blueprints
###########################################
-This section lists some of the peripherals proposed to be used (and supported) as part of All Scenarios OS Blueprints.
+This section lists some of the peripherals proposed to be used (and supported) as part of |main_project_name| Blueprints.
Peripheral Categories
*********************
diff --git a/docs/hardware-support/blueprint-peripherals/io-devices/index.rst b/docs/hardware-support/blueprint-peripherals/io-devices/index.rst
index 55ac69e235540b3a1393e915e53ada5c6f0481a2..6421d6ee24c240bf3dbb9a3251fe28a72dad2cb3 100644
--- a/docs/hardware-support/blueprint-peripherals/io-devices/index.rst
+++ b/docs/hardware-support/blueprint-peripherals/io-devices/index.rst
@@ -2,17 +2,19 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
+.. include:: ../../../definitions.rst
+
Input/Output Peripherals used in blueprints
###########################################
-This section lists some of the peripherals used for input and output used as part of All Scenarios OS Blueprints.
+This section lists some of the peripherals used for input and output used as part of |main_project_name| Blueprints.
.. toctree::
:maxdepth: 3
Touch-based input
*****************
-Smart devices accept a variety of input, typically through different types of touch interfaces. Here are a few that are used to produce All Scenarios OS Blueprints.
+Smart devices accept a variety of input, typically through different types of touch interfaces. Here are a few that are used to produce |main_project_name| Blueprints.
Capacitive Touch Sensor
-----------------------
diff --git a/docs/hardware-support/blueprint-peripherals/lock-devices/index.rst b/docs/hardware-support/blueprint-peripherals/lock-devices/index.rst
index 17356bdea831cbd99176a240f30c5cbc984042d2..3b72e5c9ed9952d17708ada8f7840f744f0a60ec 100644
--- a/docs/hardware-support/blueprint-peripherals/lock-devices/index.rst
+++ b/docs/hardware-support/blueprint-peripherals/lock-devices/index.rst
@@ -2,10 +2,12 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
+.. include:: ../../../definitions.rst
+
Lock Peripherals used in blueprints
###################################
-Smart devices might need keyless locking functionality, e.g., a vending machine, a post box, or a smart door lock. Here are a few that are used in All Scenarios OS Blueprints.
+Smart devices might need keyless locking functionality, e.g., a vending machine, a post box, or a smart door lock. Here are a few that are used in |main_project_name| Blueprints.
.. toctree::
:maxdepth: 3
diff --git a/docs/hardware-support/boards/96b-nitrogen.rst b/docs/hardware-support/boards/96b-nitrogen.rst
index 8ee18cbdd2a9177b345dca11a51c2d352059c158..1968ad42f0bff4b6036f7177a1e4f0168dda020b 100644
--- a/docs/hardware-support/boards/96b-nitrogen.rst
+++ b/docs/hardware-support/boards/96b-nitrogen.rst
@@ -2,6 +2,8 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
+.. include:: ../../definitions.rst
+
.. _SupportedBoardNitrogen:
96Boards Nitrogen
@@ -38,7 +40,7 @@ Working with the board
Building an application
=======================
-All Scenarios OS OS Zephyr flavour is based on Zephyr kernel.
+|main_project_name| OS Zephyr flavour is based on Zephyr kernel.
* Source the environment with proper template settings, flavour being zephyr and target machine being 96b-nitrogen:
diff --git a/docs/hardware-support/boards/arduino-nano-33-ble.rst b/docs/hardware-support/boards/arduino-nano-33-ble.rst
index 345d42a2dcc558750bfa334080f960f00342326c..f3324c3ade6f3c378f1d3bd51d1ff407b29bc8b4 100644
--- a/docs/hardware-support/boards/arduino-nano-33-ble.rst
+++ b/docs/hardware-support/boards/arduino-nano-33-ble.rst
@@ -2,6 +2,8 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
+.. include:: ../../definitions.rst
+
.. _SupportedBoardArduinoNano33BLE:
Arduino Nano 33 BLE
@@ -43,7 +45,7 @@ Working with the board
Building an application
=======================
-All Scenarios OS Zephyr flavour is based on the Zephyr kernel.
+|main_project_name| Zephyr flavour is based on the Zephyr kernel.
1. Source the environment with proper template settings, the flavour being *zephyr*
and target machine being *arduino-nano-33-ble*:
diff --git a/docs/hardware-support/boards/index.rst b/docs/hardware-support/boards/index.rst
index a3b46352a6714d9112a43d3b42f89e92c4ee241c..b82b2da6d13cd3ac579a647740d9b68f9227ca32 100644
--- a/docs/hardware-support/boards/index.rst
+++ b/docs/hardware-support/boards/index.rst
@@ -2,10 +2,12 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
+.. include:: ../../definitions.rst
+
Supported Boards
################
-This section details the boards supported as part of All Scenarios OS.
+This section details the boards supported as part of |main_project_name|.
.. toctree::
:maxdepth: 1
diff --git a/docs/hardware-support/boards/nRF52840-DK.rst b/docs/hardware-support/boards/nRF52840-DK.rst
index d72b2d3798422cd8d606c8898fc3c6a561cb4b2c..0577ae09e041008b93ab3da48f70dc2a4e60a243 100644
--- a/docs/hardware-support/boards/nRF52840-DK.rst
+++ b/docs/hardware-support/boards/nRF52840-DK.rst
@@ -2,6 +2,8 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
+.. include:: ../../definitions.rst
+
.. _SupportedBoardnRF52840DK:
nRF52840 DK
@@ -30,7 +32,7 @@ Working with the board
Building an application
=======================
-All Scenarios OS Zephyr flavour is based on Zephyr kernel.
+|main_project_name| Zephyr flavour is based on Zephyr kernel.
1. Source the environment with proper template settings, flavour being ``zephyr``
and target machine being ``nrf52840dk-nrf52840``:
diff --git a/docs/hardware-support/boards/raspberrypi4.rst b/docs/hardware-support/boards/raspberrypi4.rst
index e645d7857a7cff02f2d30d490e46319cdf991336..10cde476734893677cc0791a26ada7fab385ebf1 100644
--- a/docs/hardware-support/boards/raspberrypi4.rst
+++ b/docs/hardware-support/boards/raspberrypi4.rst
@@ -2,6 +2,8 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
+.. include:: ../../definitions.rst
+
.. _raspberrypi:
Raspberry Pi 4 Model B
@@ -50,8 +52,8 @@ For more details on the Raspberry Pi 4 board, see `Raspberry Pi hardware page
Working with the board
**********************
-Building All Scenarios OS image
-===============================
+Building |main_project_name| image
+==================================
To clone the source code, perform the procedure in: :ref:`Setting up a repo
workspace <RepoWorkspace>`.
@@ -84,8 +86,8 @@ Linux image
The key file which is needed to flash into the SD card is
``allscenarios-image-base-raspberrypi4-64.wic.bz2``.
-Flashing All Scenarios OS Linux Image
-*************************************
+Flashing |main_project_name| Linux Image
+****************************************
SD card
=======
diff --git a/docs/hardware-support/boards/seco-intel-b68.rst b/docs/hardware-support/boards/seco-intel-b68.rst
index d8fa948b754a47d0c829f3cd04fd2f19df53ee68..7437c9ff02f4bf48e698f668ad88d82971c41281 100644
--- a/docs/hardware-support/boards/seco-intel-b68.rst
+++ b/docs/hardware-support/boards/seco-intel-b68.rst
@@ -2,6 +2,8 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
+.. include:: ../../definitions.rst
+
.. _SupportedBoardSecoB68:
SBC-B68-eNUC SECO
diff --git a/docs/hardware-support/index.rst b/docs/hardware-support/index.rst
index 5c526ed8e6129c1fbc3dbc890e0a372af5b8ab42..1d2c38673e48a76b0cbb534e9d3f3616041cbd75 100644
--- a/docs/hardware-support/index.rst
+++ b/docs/hardware-support/index.rst
@@ -2,13 +2,15 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
+.. include:: ../definitions.rst
+
.. _HardwareSupport:
-Hardware support in All Scenarios OS
-####################################
+Hardware support in |main_project_name|
+#######################################
This section details the hardware (including virtualized) supported as part of
-All Scenarios OS.
+|main_project_name|.
.. toctree::
:maxdepth: 2
diff --git a/docs/hardware-support/virtual-boards/index.rst b/docs/hardware-support/virtual-boards/index.rst
index eb4aa161cc211a7f0c73ccb2db840e76d130d608..b21ca7c6b5f90e42dbc8feae3e9055b6c17f317e 100644
--- a/docs/hardware-support/virtual-boards/index.rst
+++ b/docs/hardware-support/virtual-boards/index.rst
@@ -2,10 +2,12 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
+.. include:: ../../definitions.rst
+
Supported Virtual Targets
#########################
-This section details the support for virtual targets in All Scenarios OS.
+This section details the support for virtual targets in |main_project_name|.
.. toctree::
:maxdepth: 1
diff --git a/docs/hardware-support/virtual-boards/qemux86-64.rst b/docs/hardware-support/virtual-boards/qemux86-64.rst
index 9d51956fc909a965aadf4b3f7fced9e12f57bd7d..cc0c8f5dec57336801e1f2ee2a236ae3b72291e9 100644
--- a/docs/hardware-support/virtual-boards/qemux86-64.rst
+++ b/docs/hardware-support/virtual-boards/qemux86-64.rst
@@ -2,6 +2,8 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
+.. include:: ../../definitions.rst
+
Qemu X86-64
###########
@@ -11,7 +13,7 @@ Qemu X86-64
Overview
********
-All Scenarios OS supports running the software stack into an virtual environment using Qemu.
+|main_project_name| supports running the software stack into an virtual environment using Qemu.
Building OHOS image
===================
diff --git a/docs/hardware-support/virtual-boards/qemux86.rst b/docs/hardware-support/virtual-boards/qemux86.rst
index 3e88b2abe3c44f66838822341c076a25a8b7e033..4b85c44184271e0c454d6b5bb678ee90a53323c2 100644
--- a/docs/hardware-support/virtual-boards/qemux86.rst
+++ b/docs/hardware-support/virtual-boards/qemux86.rst
@@ -2,6 +2,8 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
+.. include:: ../../definitions.rst
+
Qemu X86
########
@@ -11,7 +13,7 @@ Qemu X86
Overview
********
-All Scenarios OS supports running the software stack into an virtual environment using Qemu.
+|main_project_name| supports running the software stack into an virtual environment using Qemu.
Building OHOS image
===================
diff --git a/docs/os/index.rst b/docs/os/index.rst
index d3c095d1ab1065321eb2083ae9e91a0ea1ce3b26..5ade90a504f2c6c9bb9e76f73ada2a87b56d02b6 100644
--- a/docs/os/index.rst
+++ b/docs/os/index.rst
@@ -2,10 +2,12 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
+.. include:: ../definitions.rst
+
Operating System
################
-All Scenarios OS provides support for a set of kernels. This documentation
+|main_project_name| provides support for a set of kernels. This documentation
details various aspects for each kernel type.
.. toctree::
diff --git a/docs/os/linux/index.rst b/docs/os/linux/index.rst
index e57e6b9aef88327fd455799d28b335859c780824..9e0df63728ecaae16527dd4d3ddec9294f914587 100644
--- a/docs/os/linux/index.rst
+++ b/docs/os/linux/index.rst
@@ -2,8 +2,10 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
-All Scenarios OS - Linux
-########################
+.. include:: ../../definitions.rst
+
+|main_project_name| - Linux
+###########################
.. toctree::
:maxdepth: 1
diff --git a/docs/os/supported-technologies/index.rst b/docs/os/supported-technologies/index.rst
index 41fc4a22cbfca2651da5eaaebaa4fba53357e929..3b6fae3929c753121d7699683d3aec66e5d15b2d 100644
--- a/docs/os/supported-technologies/index.rst
+++ b/docs/os/supported-technologies/index.rst
@@ -2,12 +2,14 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
+.. include:: ../../definitions.rst
+
.. _SupportedTechnologies:
Supported Technologies
######################
-This section details the supported technologies in All Scenarios OS.
+This section details the supported technologies in |main_project_name|.
.. toctree::
:maxdepth: 1
diff --git a/docs/repo-workspace.rst b/docs/repo-workspace.rst
index 38d59d5135ec477c2c6e5b45696100b4aeb00871..83a54af0a96f87ac7152b5a2c2d753aff8233132 100644
--- a/docs/repo-workspace.rst
+++ b/docs/repo-workspace.rst
@@ -2,14 +2,16 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
+.. include:: definitions.rst
+
.. _RepoWorkspace:
Repo Workspace
##############
-All Scenarios OS uses `repo <https://android.googlesource.com/tools/repo>`_ to
+|main_project_name| uses `repo <https://android.googlesource.com/tools/repo>`_ to
provide full workspace setup that includes all the repositories needed for
-building All Scenarios OS and developing on top.
+building |main_project_name| and developing on top.
.. contents::
:depth: 2
@@ -17,10 +19,10 @@ building All Scenarios OS and developing on top.
The Repo Tool
*************
-In order to setup a sources workspace of All Scenarios OS, the ``git-repo`` tool is
+In order to setup a sources workspace of |main_project_name|, the ``git-repo`` tool is
required on the host.
-All Scenarios OS provides a patched version of the repo tool for ``Ubuntu 20.04``
+|main_project_name| provides a patched version of the repo tool for ``Ubuntu 20.04``
at `launchpad PPA <https://launchpad.net/~openharmony/+archive/ubuntu/tools>`_,
for ``rpm``/``dnf`` based distributions at
`copr <https://copr.fedorainfracloud.org/coprs/openharmony/tools/>`_, and for
@@ -72,7 +74,7 @@ Then install the ``repo`` package with pacman.
On OpenMandriva:
----------------
-OpenMandriva has already added All Scenarios OS's version of ``repo`` to its official
+OpenMandriva has already added |main_project_name| version of ``repo`` to its official
repositories. If you're on OpenMandriva, simply ``dnf install repo``.
@@ -91,7 +93,7 @@ Setting up the Workspace
************************
Once the repo tool is installed, you can initialize and populate the workspace.
-This will bring in all the needed sources for building All Scenarios OS:
+This will bring in all the needed sources for building |main_project_name|:
.. code-block:: console
diff --git a/docs/supported-images.rst b/docs/supported-images.rst
index 568714581455546fbceb084a265d7e24fc20f458..d6899afa806a7c4541dac0f08eae2e0dc9a6254f 100644
--- a/docs/supported-images.rst
+++ b/docs/supported-images.rst
@@ -2,11 +2,13 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
+.. include:: definitions.rst
+
Supported Images
################
To create a custom Linux distribution to match the product requirements,
-All Scenarios OS includes a set of predefined images for developing a product image.
+|main_project_name| includes a set of predefined images for developing a product image.
Linux Kernel
************
@@ -14,7 +16,7 @@ Linux Kernel
The Linux kernel is a free and open-source Unix-like operating system (OS)
kernel that serves as the primary interface between the computer's hardware and its processes.
-All Scenarios OS supports the following images listed in the table:
+|main_project_name| supports the following images listed in the table:
.. list-table:: Linux supported images
:header-rows: 1
@@ -23,11 +25,11 @@ All Scenarios OS supports the following images listed in the table:
- Description
* - allscenarios-image-base
-
- * All Scenarios OS image including the base OS software stack.
+ * |main_project_name| image including the base OS software stack.
* This image also includes middleware and application packages to support a wide range of hardware which includes WiFi, Bluetooth, sound, and serial ports.
* - allscenarios-image-extra
-
- * All Scenarios OS Wayland image including the base OS software stack. This is a Wayland protocol and Weston reference compositor-based image.
+ * |main_project_name| Wayland image including the base OS software stack. This is a Wayland protocol and Weston reference compositor-based image.
* It uses the Wayland protocol and implementation to exchange data with its clients.
* This image provides the Wayland protocol libraries and the reference Weston compositor and includes a Wayland-capable terminal program.
@@ -41,7 +43,7 @@ that is intended for use on resource-constrained and embedded systems.
For more detailed information on Zephyr OS Kernel, see `Zephyr documentation <https://docs.zephyrproject.org/latest/index.html#>`_.
-All Scenarios OS supports the following images for the Zephyr OS kernel:
+|main_project_name| supports the following images for the Zephyr OS kernel:
.. list-table:: Zephyr supported images
:header-rows: 1
@@ -60,7 +62,7 @@ The FreeRTOS kernel is a real-time operating system (RTOS) that runs on a variet
of platforms which is used to build microcontroller-based embedded applications.
The standard RTOS kernel binary image ranges from 4000 to 9000 bytes.
-All Scenarios OS supports the following images for FreeRTOS Kernel:
+|main_project_name| supports the following images for FreeRTOS Kernel:
.. list-table:: FreeRTOS supported images
:header-rows: 1
diff --git a/docs/yocto-build-system/index.rst b/docs/yocto-build-system/index.rst
index cd439bd5bcd35456a226e69ddf6ead135ee4060c..9d82ed4b323897be85a11dd687df312246b70daf 100644
--- a/docs/yocto-build-system/index.rst
+++ b/docs/yocto-build-system/index.rst
@@ -2,12 +2,14 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
-All Scenarios OS, a Yocto-based Build System
-############################################
+.. include:: ../definitions.rst
-All Scenarios OS build system, the foundation of the build infrastructure, is based
+|main_project_name|, a Yocto-based Build System
+###############################################
+
+|main_project_name| build system, the foundation of the build infrastructure, is based
on `Poky, the Yocto Project open source reference embedded distribution <https://www.yoctoproject.org/software-overview/>`_.
-This section details both generic and All Scenarios OS specific aspects of the build system.
+This section details both generic and |main_project_name| specific aspects of the build system.
.. toctree::
:maxdepth: 1
diff --git a/docs/yocto-build-system/ohos-build-arch.rst b/docs/yocto-build-system/ohos-build-arch.rst
index c791cc606eae863667621bd19498a412ca74d30a..a7b4a9db9b81f6756b5a3e04238a86d9b8813c2e 100644
--- a/docs/yocto-build-system/ohos-build-arch.rst
+++ b/docs/yocto-build-system/ohos-build-arch.rst
@@ -2,8 +2,10 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
-All Scenarios OS Build Architecture
-###################################
+.. include:: ../definitions.rst
+
+|main_project_name| Build Architecture
+######################################
``meta-ohos`` architecture is documented using `c4 model <https://c4model.com/>`_.
@@ -13,11 +15,11 @@ All Scenarios OS Build Architecture
Overview
********
-All Scenarios OS build infrastructure is designed to run atop variety of OS kernels
+|main_project_name| build infrastructure is designed to run atop variety of OS kernels
ranging from RTOSes to Linux.
``meta-ohos`` is an *umbrella* of meta layers containing build's meta-data
-required for compiling All Scenarios OS images. The architecture supports plugging
+required for compiling |main_project_name| images. The architecture supports plugging
various kernels.
.. image:: assets/meta-ohos-arch.png
diff --git a/docs/yocto-build-system/yocto-project.rst b/docs/yocto-build-system/yocto-project.rst
index b579624b1e9941190dfec94c25dc5c175b79e29e..1f4d521b95440149e0003c9f3864d3e6bc8ca169 100644
--- a/docs/yocto-build-system/yocto-project.rst
+++ b/docs/yocto-build-system/yocto-project.rst
@@ -2,10 +2,12 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
+.. include:: ../definitions.rst
+
Poky/Yocto Project
##################
-All Scenarios OS aims to use standard opensource tools to create a build environment
+|main_project_name| aims to use standard opensource tools to create a build environment
that is both familiar to users in the domain but also flexible enough for the
requirements of the project. With this in mind, the project build
infrastructure is based on the OpenEmbedded build system, more specifically
@@ -29,10 +31,10 @@ in the build system.
See `terms for reference <https://www.yoctoproject.org/software-overview/>`_
for more information.
-All Scenarios OS Build Layers
------------------------------
+|main_project_name| Build Layers
+--------------------------------
-All Scenarios OS bases its build setup on Poky, the Yocto Project open source
+|main_project_name| bases its build setup on Poky, the Yocto Project open source
reference embedded distribution. The main hub of layers, is `meta-ohos <https://git.ostc-eu.org/OSTC/meta-ohos/>`_,
a collection of layers with different scopes for defining the project's
requirements and capabilities.