Skip to content
Snippets Groups Projects
Commit d20b1ea5 authored by Zygmunt Krynicki's avatar Zygmunt Krynicki
Browse files

docs: say All Scenario OS in sentences


Acronym looks good in some places but in sentences the full name is more
readable.

Signed-off-by: default avatarZygmunt Krynicki <zygmunt.krynicki@huawei.com>
parent 8254a504
No related branches found
No related tags found
No related merge requests found
Showing
with 49 additions and 49 deletions
...@@ -6,7 +6,7 @@ ...@@ -6,7 +6,7 @@
all: all:
sphinx-build -W -C \ sphinx-build -W -C \
-D html_theme=sphinx_rtd_theme \ -D html_theme=sphinx_rtd_theme \
-D project='AllScenariOS Build System and meta-ohos' \ -D project='All Scenario OS Build System and meta-ohos' \
-D copyright='Huawei Inc' \ -D copyright='Huawei Inc' \
. build . build
......
...@@ -4,15 +4,15 @@ ...@@ -4,15 +4,15 @@
.. _AllScenariOSQuickBuild: .. _AllScenariOSQuickBuild:
AllScenariOS - Quick Build All Scenario OS - Quick Build
########################## #############################
This section will guide you to building your first AllScenariOS image targeting This section will guide you to building your first All Scenario 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 AllScenariOS on a real hardware, checkout the :ref:`Avenger96 support page of All Scenario OS on a real hardware, checkout the :ref:`Avenger96 support page
<SupportedBoardAvenger96>`. <SupportedBoardAvenger96>`.
.. contents:: .. contents::
...@@ -69,8 +69,8 @@ Initialize the build directory and run a build: ...@@ -69,8 +69,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 AllScenariOS image Booting a Qemu X86-64 target with a All Scenario OS image
****************************************************** *********************************************************
Once the build is done, you can run a Qemu X86-64 instance as it follows: Once the build is done, you can run a Qemu X86-64 instance as it follows:
......
...@@ -2,11 +2,11 @@ ...@@ -2,11 +2,11 @@
.. ..
.. SPDX-License-Identifier: CC-BY-4.0 .. SPDX-License-Identifier: CC-BY-4.0
AllScenariOS Blueprints All Scenario OS Blueprints
####################### ##########################
This section details the available blueprints provided as part of the This section details the available blueprints provided as part of the
AllScenariOS environment. All Scenario OS environment.
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
......
...@@ -29,7 +29,7 @@ How to build ...@@ -29,7 +29,7 @@ How to build
The Linux Gateway The Linux Gateway
----------------- -----------------
1. Refer to :ref:`Building OHOS image for Avenger96 <SupportedBoardAvenger96>` to learn how to set up a build environment, build and flash a base AllScenariOS Linux image. 1. Refer to :ref:`Building OHOS image for Avenger96 <SupportedBoardAvenger96>` to learn how to set up a build environment, build and flash a base All Scenario OS Linux image.
2. Build blueprint image by invoking following bitbake command 2. Build blueprint image by invoking following bitbake command
.. code-block:: console .. code-block:: console
......
...@@ -5,9 +5,9 @@ ...@@ -5,9 +5,9 @@
Overview of Build Flavours Overview of Build Flavours
########################## ##########################
AllScenariOS can be hosted on top of variety of kernels. Currently supported All Scenario 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 AllScenariOS requires build configuration that is specific to each kernel and All Scenario 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
############################# #############################
AllScenariOS FreeRTOS build flavour is based on *freertos* distribution (distro configuration). All Scenario 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
AllScenariOS Build Flavours All Scenario OS Build Flavours
########################### ##############################
AllScenariOS provides default build configuration for each supported type of All Scenario 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
########################## ##########################
AllScenariOS Linux build flavour is based on *allscenarios-linux* distribution (distro configuration). All Scenario 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 AllScenariOS Adding Hardware Support in All Scenario 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
AllScenariOS. It is intended as a checklist for adding new boards to OHOS build All Scenario OS. It is intended as a checklist for adding new boards to OHOS build
system. system.
Before starting get familiar with AllScenariOS Contribution Process. Before starting get familiar with All Scenario OS Contribution Process.
.. contents:: .. contents::
:depth: 2 :depth: 2
Select AllScenariOS Flavour Select All Scenario OS Flavour
*************************** ******************************
AllScenariOS uses a notion of kernel specific flavours: All Scenario 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
AllScenariOS build system uses ***repo*** tool for cloning required meta-layers All Scenario 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
- AllScenariOS image including the base OS software stack - All Scenario OS image including the base OS software stack
* - allscenarios-image-extra * - allscenarios-image-extra
- Approximate 100-200 MB - Approximate 100-200 MB
- AllScenariOS Wayland image including the base OS software stack - All Scenario 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
======================= =======================
AllScenariOS OS Zephyr flavour is based on Zephyr kernel. All Scenario 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:
......
...@@ -5,7 +5,7 @@ ...@@ -5,7 +5,7 @@
Supported Boards Supported Boards
################ ################
This section details the boards supported as part of AllScenariOS. This section details the boards supported as part of All Scenario OS.
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
......
...@@ -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
- AllScenariOS image including the base OS software stack - All Scenario 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
- AllScenariOS image including the base OS software stack - All Scenario OS image including the base OS software stack
* - allscenarios-image-extra * - allscenarios-image-extra
- Approximate 100-200 MB - Approximate 100-200 MB
- AllScenariOS Wayland image including the base OS software stack - All Scenario OS Wayland image including the base OS software stack
Building OHOS image Building OHOS image
......
...@@ -4,11 +4,11 @@ ...@@ -4,11 +4,11 @@
.. _HardwareSupport: .. _HardwareSupport:
Hardware support in AllScenariOS Hardware support in All Scenario OS
################################ ###################################
This section details the hardware (including virtualized) supported as part of This section details the hardware (including virtualized) supported as part of
AllScenariOS. All Scenario OS.
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
......
...@@ -5,7 +5,7 @@ ...@@ -5,7 +5,7 @@
Supported Virtual Targets Supported Virtual Targets
######################### #########################
This section details the support for virtual targets in AllScenariOS. This section details the support for virtual targets in All Scenario OS.
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
......
...@@ -11,7 +11,7 @@ Qemu ARM ...@@ -11,7 +11,7 @@ Qemu ARM
Overview Overview
******** ********
AllScenariOS supports running the software stack into an virtual environment using Qemu. All Scenario 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
- AllScenariOS image including the base OS software stack - All Scenario OS image including the base OS software stack
* - allscenarios-image-extra * - allscenarios-image-extra
- AllScenariOS Wayland image including the base OS software stack - All Scenario 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
******** ********
AllScenariOS supports running the software stack into an virtual environment using Qemu. All Scenario 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
- AllScenariOS image including the base OS software stack - All Scenario OS image including the base OS software stack
* - allscenarios-image-extra * - allscenarios-image-extra
- AllScenariOS Wayland image including the base OS software stack - All Scenario 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
******** ********
AllScenariOS supports running the software stack into an virtual environment using Qemu. All Scenario 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
- AllScenariOS image including the base OS software stack - All Scenario OS image including the base OS software stack
* - allscenarios-image-extra * - allscenarios-image-extra
- AllScenariOS Wayland image including the base OS software stack - All Scenario 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
******** ********
AllScenariOS supports running the software stack into an virtual environment using Qemu. All Scenario 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
- AllScenariOS image including the base OS software stack - All Scenario OS image including the base OS software stack
* - allscenarios-image-extra * - allscenarios-image-extra
- AllScenariOS Wayland image including the base OS software stack - All Scenario OS Wayland image including the base OS software stack
Build steps Build steps
----------- -----------
......
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