Skip to content
Snippets Groups Projects
Commit 5c9218cd authored by Arul Kumaran's avatar Arul Kumaran
Browse files

docs: Rename 'All scenario' to 'All scenarios'


* All topics revised to reflect All scenarios OS instead of All scenario
  OS to maintain consistency, fixes issue#70

Signed-off-by: default avatarArul Kumaran <arulkumaran.devarajan@huawei.com>
parent 99d2d299
No related branches found
No related tags found
No related merge requests found
Showing
with 63 additions and 63 deletions
...@@ -4,15 +4,15 @@ ...@@ -4,15 +4,15 @@
.. _AllScenariOSQuickBuild: .. _AllScenariOSQuickBuild:
All Scenario OS - Quick Build All Scenarios OS - Quick Build
############################# ##############################
This section will guide you to building your first All Scenario OS image targeting This section will guide you to building your first All Scenarios OS image targeting
a supported reference hardware. It will also provide the steps for flashing and a supported reference hardware. It will also provide the steps for flashing and
booting such an image. booting such an image.
The steps below will focus on a Qemu-based target. If you want to get a feeling The steps below will focus on a Qemu-based target. If you want to get a feeling
of All Scenario OS on a real hardware, checkout the :ref:`Avenger96 support page of All Scenarios OS on a real hardware, checkout the :ref:`Avenger96 support page
<SupportedBoardAvenger96>`. <SupportedBoardAvenger96>`.
.. contents:: .. contents::
...@@ -74,8 +74,8 @@ Initialize the build directory and run a build: ...@@ -74,8 +74,8 @@ Initialize the build directory and run a build:
$ TEMPLATECONF=../sources/meta-ohos/flavours/linux . ./sources/poky/oe-init-build-env build-ohos-linux $ TEMPLATECONF=../sources/meta-ohos/flavours/linux . ./sources/poky/oe-init-build-env build-ohos-linux
$ MACHINE=qemux86-64 bitbake allscenarios-image-base $ MACHINE=qemux86-64 bitbake allscenarios-image-base
Booting a Qemu X86-64 target with a All Scenario OS image Booting a Qemu X86-64 target with a All Scenarios OS image
********************************************************* **********************************************************
Once the image is built, you can run a Qemu X86-64 instance using the provided script wrapper as follows: Once the image is built, you can run a Qemu X86-64 instance using the provided script wrapper as follows:
......
...@@ -5,9 +5,9 @@ ...@@ -5,9 +5,9 @@
Overview of Build Flavours Overview of Build Flavours
########################## ##########################
All Scenario OS can be hosted on top of variety of kernels. Currently supported All Scenarios OS can be hosted on top of variety of kernels. Currently supported
kernels are Linux, Zephyr and FreeRTOS (experimental). The build system kernels are Linux, Zephyr and FreeRTOS (experimental). The build system
requires build configuration that is specific to each kernel and All Scenario OS requires build configuration that is specific to each kernel and All Scenarios OS
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>`_ 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. for more info about the underlying mechanism.
......
...@@ -5,7 +5,7 @@ ...@@ -5,7 +5,7 @@
FreeRTOS Kernel Build Flavour FreeRTOS Kernel Build Flavour
############################# #############################
All Scenario OS FreeRTOS build flavour is based on *freertos* distribution (distro configuration). All Scenarios OS FreeRTOS build flavour is based on *freertos* distribution (distro configuration).
Supported images: Supported images:
......
...@@ -2,10 +2,10 @@ ...@@ -2,10 +2,10 @@
.. ..
.. SPDX-License-Identifier: CC-BY-4.0 .. SPDX-License-Identifier: CC-BY-4.0
All Scenario OS Build Flavours All Scenarios OS Build Flavours
############################## ###############################
All Scenario OS provides default build configuration for each supported type of All Scenarios OS provides default build configuration for each supported type of
kernels. Each set of such configuration is called a ``flavour``. kernels. Each set of such configuration is called a ``flavour``.
.. toctree:: .. toctree::
......
...@@ -5,7 +5,7 @@ ...@@ -5,7 +5,7 @@
Linux Kernel Build Flavour Linux Kernel Build Flavour
########################## ##########################
All Scenario OS Linux build flavour is based on *allscenarios-linux* distribution (distro configuration). All Scenarios OS Linux build flavour is based on *allscenarios-linux* distribution (distro configuration).
Supported images: Supported images:
......
...@@ -2,22 +2,22 @@ ...@@ -2,22 +2,22 @@
.. ..
.. SPDX-License-Identifier: CC-BY-4.0 .. SPDX-License-Identifier: CC-BY-4.0
Adding Hardware Support in All Scenario OS Adding Hardware Support in All Scenarios OS
########################################## ###########################################
This section details the addition of new hardware to the supported set in This section details the addition of new hardware to the supported set in
All Scenario OS. It is intended as a checklist for adding new boards to OHOS build All Scenarios OS. It is intended as a checklist for adding new boards to OHOS build
system. system.
Before starting get familiar with All Scenario OS Contribution Process. Before starting get familiar with All Scenarios OS Contribution Process.
.. contents:: .. contents::
:depth: 2 :depth: 2
Select All Scenario OS Flavour Select All Scenarios OS Flavour
****************************** *******************************
All Scenario OS uses a notion of kernel specific flavours: All Scenarios OS uses a notion of kernel specific flavours:
- Linux flavour - Linux flavour
- Zephyr flavour - Zephyr flavour
...@@ -47,7 +47,7 @@ directory) consist of the following files: ...@@ -47,7 +47,7 @@ directory) consist of the following files:
* default flavour build configuration * default flavour build configuration
All Scenario OS build system uses ***repo*** tool for cloning required meta-layers All Scenarios OS build system uses ***repo*** tool for cloning required meta-layers
into appropriate build directory structure (see :ref:`Setting up a repo workspace <RepoWorkspace>`). 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: To include a new layer, it has to be added in two places:
......
...@@ -43,10 +43,10 @@ Supported images ...@@ -43,10 +43,10 @@ Supported images
- Description - Description
* - allscenarios-image-base * - allscenarios-image-base
- Approximate 100-200 MB - Approximate 100-200 MB
- All Scenario OS image including the base OS software stack - All Scenarios OS image including the base OS software stack
* - allscenarios-image-extra * - allscenarios-image-extra
- Approximate 100-200 MB - Approximate 100-200 MB
- All Scenario OS Wayland image including the base OS software stack - All Scenarios OS Wayland image including the base OS software stack
Building OHOS image Building OHOS image
......
...@@ -43,7 +43,7 @@ Supported image ...@@ -43,7 +43,7 @@ Supported image
Building an application Building an application
======================= =======================
All Scenario OS OS Zephyr flavour is based on Zephyr kernel. All Scenarios OS OS Zephyr flavour is based on Zephyr kernel.
* Source the environment with proper template settings, flavour being zephyr and target machine being 96b-nitrogen: * Source the environment with proper template settings, flavour being zephyr and target machine being 96b-nitrogen:
......
...@@ -60,12 +60,12 @@ Supported images ...@@ -60,12 +60,12 @@ Supported images
* - Image Name * - Image Name
- Description - Description
* - allscenarios-image-base * - allscenarios-image-base
- All Scenario OS image including the base OS software stack - All Scenarios OS image including the base OS software stack
* - allscenarios-image-extra * - allscenarios-image-extra
- All Scenario OS Wayland image including the base OS software stack - All Scenarios OS Wayland image including the base OS software stack
Building All Scenario OS image Building All Scenarios OS image
============================== ===============================
To clone the source code, perform the procedure in: :ref:`Setting up a repo To clone the source code, perform the procedure in: :ref:`Setting up a repo
workspace <RepoWorkspace>`. workspace <RepoWorkspace>`.
...@@ -98,8 +98,8 @@ Linux image ...@@ -98,8 +98,8 @@ Linux image
The key file which is needed to flash into the SD card is The key file which is needed to flash into the SD card is
"allscenarios-image-base-raspberrypi4-64.wic.bz2" "allscenarios-image-base-raspberrypi4-64.wic.bz2"
Flashing All Scenario OS Linux Image Flashing All Scenarios OS Linux Image
************************************ *************************************
SD card SD card
======= =======
......
...@@ -41,7 +41,7 @@ Supported image ...@@ -41,7 +41,7 @@ Supported image
- Description - Description
* - allscenarios-image-base * - allscenarios-image-base
- Approximate 100-200 MB - Approximate 100-200 MB
- All Scenario OS image including the base OS software stack - All Scenarios OS image including the base OS software stack
Building OHOS image Building OHOS image
......
...@@ -40,10 +40,10 @@ Supported images ...@@ -40,10 +40,10 @@ Supported images
- Description - Description
* - allscenarios-image-base * - allscenarios-image-base
- Approximate 100-200 MB - Approximate 100-200 MB
- All Scenario OS image including the base OS software stack - All Scenarios OS image including the base OS software stack
* - allscenarios-image-extra * - allscenarios-image-extra
- Approximate 100-200 MB - Approximate 100-200 MB
- All Scenario OS Wayland image including the base OS software stack - All Scenarios OS Wayland image including the base OS software stack
Building OHOS image Building OHOS image
......
...@@ -11,7 +11,7 @@ Qemu ARM ...@@ -11,7 +11,7 @@ Qemu ARM
Overview Overview
******** ********
All Scenario OS supports running the software stack into an virtual environment using Qemu. All Scenarios OS supports running the software stack into an virtual environment using Qemu.
Building OHOS image Building OHOS image
=================== ===================
...@@ -31,9 +31,9 @@ Supported images ...@@ -31,9 +31,9 @@ Supported images
* - Image Name * - Image Name
- Description - Description
* - allscenarios-image-base * - allscenarios-image-base
- All Scenario OS image including the base OS software stack - All Scenarios OS image including the base OS software stack
* - allscenarios-image-extra * - allscenarios-image-extra
- All Scenario OS Wayland image including the base OS software stack - All Scenarios OS Wayland image including the base OS software stack
Build steps Build steps
----------- -----------
......
...@@ -11,7 +11,7 @@ Qemu ARM64 ...@@ -11,7 +11,7 @@ Qemu ARM64
Overview Overview
******** ********
All Scenario OS supports running the software stack into an virtual environment using Qemu. All Scenarios OS supports running the software stack into an virtual environment using Qemu.
Building OHOS image Building OHOS image
=================== ===================
...@@ -31,9 +31,9 @@ Supported images ...@@ -31,9 +31,9 @@ Supported images
* - Image Name * - Image Name
- Description - Description
* - allscenarios-image-base * - allscenarios-image-base
- All Scenario OS image including the base OS software stack - All Scenarios OS image including the base OS software stack
* - allscenarios-image-extra * - allscenarios-image-extra
- All Scenario OS Wayland image including the base OS software stack - All Scenarios OS Wayland image including the base OS software stack
Build steps Build steps
----------- -----------
......
...@@ -11,7 +11,7 @@ Qemu X86-64 ...@@ -11,7 +11,7 @@ Qemu X86-64
Overview Overview
******** ********
All Scenario OS supports running the software stack into an virtual environment using Qemu. All Scenarios OS supports running the software stack into an virtual environment using Qemu.
Building OHOS image Building OHOS image
=================== ===================
...@@ -31,9 +31,9 @@ Supported images ...@@ -31,9 +31,9 @@ Supported images
* - Image Name * - Image Name
- Description - Description
* - allscenarios-image-base * - allscenarios-image-base
- All Scenario OS image including the base OS software stack - All Scenarios OS image including the base OS software stack
* - allscenarios-image-extra * - allscenarios-image-extra
- All Scenario OS Wayland image including the base OS software stack - All Scenarios OS Wayland image including the base OS software stack
Build steps Build steps
----------- -----------
......
...@@ -11,7 +11,7 @@ Qemu X86 ...@@ -11,7 +11,7 @@ Qemu X86
Overview Overview
******** ********
All Scenario OS supports running the software stack into an virtual environment using Qemu. All Scenarios OS supports running the software stack into an virtual environment using Qemu.
Building OHOS image Building OHOS image
=================== ===================
...@@ -31,9 +31,9 @@ Supported images ...@@ -31,9 +31,9 @@ Supported images
* - Image Name * - Image Name
- Description - Description
* - allscenarios-image-base * - allscenarios-image-base
- All Scenario OS image including the base OS software stack - All Scenarios OS image including the base OS software stack
* - allscenarios-image-extra * - allscenarios-image-extra
- All Scenario OS Wayland image including the base OS software stack - All Scenarios OS Wayland image including the base OS software stack
Build steps Build steps
----------- -----------
......
...@@ -7,9 +7,9 @@ ...@@ -7,9 +7,9 @@
Repo Workspace Repo Workspace
############## ##############
All Scenario OS uses `repo <https://android.googlesource.com/tools/repo>`_ to All Scenarios OS uses `repo <https://android.googlesource.com/tools/repo>`_ to
provide full workspace setup that includes all the repositories needed for provide full workspace setup that includes all the repositories needed for
building All Scenario OS and developing on top. building All Scenarios OS and developing on top.
.. contents:: .. contents::
:depth: 2 :depth: 2
...@@ -17,10 +17,10 @@ building All Scenario OS and developing on top. ...@@ -17,10 +17,10 @@ building All Scenario OS and developing on top.
The Repo Tool The Repo Tool
************* *************
In order to setup a sources workspace of All Scenario OS, the ``git-repo`` tool is In order to setup a sources workspace of All Scenarios OS, the ``git-repo`` tool is
required on the host. required on the host.
All Scenario OS provides a patched version of the repo tool for ``Ubuntu 20.04`` All Scenarios OS provides a patched version of the repo tool for ``Ubuntu 20.04``
at `launchpad PPA <https://launchpad.net/~openharmony/+archive/ubuntu/tools>`_, at `launchpad PPA <https://launchpad.net/~openharmony/+archive/ubuntu/tools>`_,
for ``rpm``/``dnf`` based distributions at for ``rpm``/``dnf`` based distributions at
`copr <https://copr.fedorainfracloud.org/coprs/openharmony/tools/>`_, and for `copr <https://copr.fedorainfracloud.org/coprs/openharmony/tools/>`_, and for
...@@ -72,7 +72,7 @@ Then install the ``repo`` package with pacman. ...@@ -72,7 +72,7 @@ Then install the ``repo`` package with pacman.
On OpenMandriva: On OpenMandriva:
---------------- ----------------
OpenMandriva has already added All Scenario OS's version of ``repo`` to its official OpenMandriva has already added All Scenarios OS's version of ``repo`` to its official
repositories. If you're on OpenMandriva, simply ``dnf install repo``. repositories. If you're on OpenMandriva, simply ``dnf install repo``.
...@@ -91,7 +91,7 @@ Setting up the Workspace ...@@ -91,7 +91,7 @@ Setting up the Workspace
************************ ************************
Once the repo tool is installed, you can initialize and populate 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 Scenario OS: This will bring in all the needed sources for building All Scenarios OS:
.. code-block:: console .. code-block:: console
......
...@@ -2,12 +2,12 @@ ...@@ -2,12 +2,12 @@
.. ..
.. SPDX-License-Identifier: CC-BY-4.0 .. SPDX-License-Identifier: CC-BY-4.0
All Scenario OS, a Yocto-based Build System All Scenarios OS, a Yocto-based Build System
########################################### ############################################
All Scenario OS build system, the foundation of the build infrastructure, is based All Scenarios OS 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/>`_. on `Poky, the Yocto Project open source reference embedded distribution <https://www.yoctoproject.org/software-overview/>`_.
This section details both generic and All Scenario OS specific aspects of the build system. This section details both generic and All Scenarios OS specific aspects of the build system.
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
......
...@@ -2,8 +2,8 @@ ...@@ -2,8 +2,8 @@
.. ..
.. SPDX-License-Identifier: CC-BY-4.0 .. SPDX-License-Identifier: CC-BY-4.0
All Scenario OS Build Architecture All Scenarios OS Build Architecture
################################## ###################################
``meta-ohos`` architecture is documented using `c4 model <https://c4model.com/>`_. ``meta-ohos`` architecture is documented using `c4 model <https://c4model.com/>`_.
...@@ -13,11 +13,11 @@ All Scenario OS Build Architecture ...@@ -13,11 +13,11 @@ All Scenario OS Build Architecture
Overview Overview
******** ********
All Scenario OS build infrastructure designed to run atop variety of OS kernels All Scenarios OS build infrastructure designed to run atop variety of OS kernels
ranging from RTOSs to Linux. ranging from RTOSs to Linux.
``meta-ohos`` is a *umbrella* of meta layers containing build meta-data ``meta-ohos`` is a *umbrella* of meta layers containing build meta-data
required for compiling All Scenario OS images. The architecture supports plugging required for compiling All Scenarios OS images. The architecture supports plugging
various kernels. various kernels.
.. image:: assets/meta-ohos-arch.png .. image:: assets/meta-ohos-arch.png
...@@ -5,7 +5,7 @@ ...@@ -5,7 +5,7 @@
Poky/Yocto Project Poky/Yocto Project
################## ##################
All Scenario OS aims to use standard opensource tools to create a build environment All Scenarios OS 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 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 requirements of the project. With this in mind, the project build
infrastructure is based on the OpenEmbedded build system, more specifically infrastructure is based on the OpenEmbedded build system, more specifically
...@@ -29,10 +29,10 @@ in the build system. ...@@ -29,10 +29,10 @@ in the build system.
See `terms for reference <https://www.yoctoproject.org/software-overview/>`_ See `terms for reference <https://www.yoctoproject.org/software-overview/>`_
for more information. for more information.
All Scenario OS Build Layers All Scenarios OS Build Layers
---------------------------- -----------------------------
All Scenario OS bases its build setup on Poky, the Yocto Project open source All Scenarios OS 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/>`_, 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 a collection of layers with different scopes for defining the project's
requirements and capabilities. requirements and capabilities.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment