From d20b1ea5b9479f431d93564c5e8bf5f800319dd3 Mon Sep 17 00:00:00 2001
From: Zygmunt Krynicki <zygmunt.krynicki@huawei.com>
Date: Wed, 21 Apr 2021 09:32:19 +0000
Subject: [PATCH] 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: Zygmunt Krynicki <zygmunt.krynicki@huawei.com>
---
docs/Makefile | 2 +-
docs/allscenarios-quick-build.rst | 12 ++++++------
docs/blueprints/index.rst | 6 +++---
docs/blueprints/smart-panel.rst | 2 +-
docs/build-flavours/build-flavours.rst | 4 ++--
docs/build-flavours/freertos-flavour.rst | 2 +-
docs/build-flavours/index.rst | 6 +++---
docs/build-flavours/linux-flavour.rst | 2 +-
.../hardware-support/adding-hardware-support.rst | 16 ++++++++--------
docs/hardware-support/boards/96b-Avenger.rst | 4 ++--
docs/hardware-support/boards/96b-nitrogen.rst | 2 +-
docs/hardware-support/boards/index.rst | 2 +-
docs/hardware-support/boards/seco-imx8mm-c61.rst | 2 +-
docs/hardware-support/boards/seco-intel-b68.rst | 4 ++--
docs/hardware-support/index.rst | 6 +++---
docs/hardware-support/virtual-boards/index.rst | 2 +-
docs/hardware-support/virtual-boards/qemuarm.rst | 6 +++---
.../virtual-boards/qemuarm64.rst | 6 +++---
.../virtual-boards/qemux86-64.rst | 6 +++---
docs/hardware-support/virtual-boards/qemux86.rst | 6 +++---
docs/repo-workspace.rst | 12 ++++++------
.../assets/ohos-build-arch.puml | 2 +-
docs/yocto-build-system/index.rst | 8 ++++----
docs/yocto-build-system/ohos-build-arch.rst | 8 ++++----
docs/yocto-build-system/yocto-project.rst | 8 ++++----
25 files changed, 68 insertions(+), 68 deletions(-)
diff --git a/docs/Makefile b/docs/Makefile
index 63bc3068..ac87306d 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -6,7 +6,7 @@
all:
sphinx-build -W -C \
-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' \
. build
diff --git a/docs/allscenarios-quick-build.rst b/docs/allscenarios-quick-build.rst
index d4f64a1b..87aa6f3d 100644
--- a/docs/allscenarios-quick-build.rst
+++ b/docs/allscenarios-quick-build.rst
@@ -4,15 +4,15 @@
.. _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
booting such an image.
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>`.
.. contents::
@@ -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
$ 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:
diff --git a/docs/blueprints/index.rst b/docs/blueprints/index.rst
index 3b11bb47..9f20496b 100644
--- a/docs/blueprints/index.rst
+++ b/docs/blueprints/index.rst
@@ -2,11 +2,11 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
-AllScenariOS Blueprints
-#######################
+All Scenario OS Blueprints
+##########################
This section details the available blueprints provided as part of the
-AllScenariOS environment.
+All Scenario OS environment.
.. toctree::
:maxdepth: 1
diff --git a/docs/blueprints/smart-panel.rst b/docs/blueprints/smart-panel.rst
index 5e3ae268..f056a70b 100644
--- a/docs/blueprints/smart-panel.rst
+++ b/docs/blueprints/smart-panel.rst
@@ -29,7 +29,7 @@ How to build
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
.. code-block:: console
diff --git a/docs/build-flavours/build-flavours.rst b/docs/build-flavours/build-flavours.rst
index 1cdb1bc5..1f33fe2b 100644
--- a/docs/build-flavours/build-flavours.rst
+++ b/docs/build-flavours/build-flavours.rst
@@ -5,9 +5,9 @@
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
-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>`_
for more info about the underlying mechanism.
diff --git a/docs/build-flavours/freertos-flavour.rst b/docs/build-flavours/freertos-flavour.rst
index 352c7588..bdfda9ca 100644
--- a/docs/build-flavours/freertos-flavour.rst
+++ b/docs/build-flavours/freertos-flavour.rst
@@ -5,7 +5,7 @@
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:
diff --git a/docs/build-flavours/index.rst b/docs/build-flavours/index.rst
index 9cfba1e6..8579a764 100644
--- a/docs/build-flavours/index.rst
+++ b/docs/build-flavours/index.rst
@@ -2,10 +2,10 @@
..
.. 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``.
.. toctree::
diff --git a/docs/build-flavours/linux-flavour.rst b/docs/build-flavours/linux-flavour.rst
index 04de9eef..036b31ef 100644
--- a/docs/build-flavours/linux-flavour.rst
+++ b/docs/build-flavours/linux-flavour.rst
@@ -5,7 +5,7 @@
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:
diff --git a/docs/hardware-support/adding-hardware-support.rst b/docs/hardware-support/adding-hardware-support.rst
index b9757e29..fb879740 100644
--- a/docs/hardware-support/adding-hardware-support.rst
+++ b/docs/hardware-support/adding-hardware-support.rst
@@ -2,22 +2,22 @@
..
.. 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
-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.
-Before starting get familiar with AllScenariOS Contribution Process.
+Before starting get familiar with All Scenario OS Contribution Process.
.. contents::
: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
- Zephyr flavour
@@ -47,7 +47,7 @@ directory) consist of the following files:
* 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>`).
To include a new layer, it has to be added in two places:
diff --git a/docs/hardware-support/boards/96b-Avenger.rst b/docs/hardware-support/boards/96b-Avenger.rst
index b7716992..3c4dcd6f 100644
--- a/docs/hardware-support/boards/96b-Avenger.rst
+++ b/docs/hardware-support/boards/96b-Avenger.rst
@@ -43,10 +43,10 @@ Supported images
- Description
* - allscenarios-image-base
- 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
- 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
diff --git a/docs/hardware-support/boards/96b-nitrogen.rst b/docs/hardware-support/boards/96b-nitrogen.rst
index f57165d3..b538f1ee 100644
--- a/docs/hardware-support/boards/96b-nitrogen.rst
+++ b/docs/hardware-support/boards/96b-nitrogen.rst
@@ -43,7 +43,7 @@ Supported image
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:
diff --git a/docs/hardware-support/boards/index.rst b/docs/hardware-support/boards/index.rst
index a6147007..a0a144d5 100644
--- a/docs/hardware-support/boards/index.rst
+++ b/docs/hardware-support/boards/index.rst
@@ -5,7 +5,7 @@
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::
:maxdepth: 1
diff --git a/docs/hardware-support/boards/seco-imx8mm-c61.rst b/docs/hardware-support/boards/seco-imx8mm-c61.rst
index 4b92be75..266d0083 100644
--- a/docs/hardware-support/boards/seco-imx8mm-c61.rst
+++ b/docs/hardware-support/boards/seco-imx8mm-c61.rst
@@ -41,7 +41,7 @@ Supported image
- Description
* - allscenarios-image-base
- 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
diff --git a/docs/hardware-support/boards/seco-intel-b68.rst b/docs/hardware-support/boards/seco-intel-b68.rst
index 5b88f9c3..c6f9ce3e 100644
--- a/docs/hardware-support/boards/seco-intel-b68.rst
+++ b/docs/hardware-support/boards/seco-intel-b68.rst
@@ -40,10 +40,10 @@ Supported images
- Description
* - allscenarios-image-base
- 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
- 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
diff --git a/docs/hardware-support/index.rst b/docs/hardware-support/index.rst
index 39b2d85e..74f103ff 100644
--- a/docs/hardware-support/index.rst
+++ b/docs/hardware-support/index.rst
@@ -4,11 +4,11 @@
.. _HardwareSupport:
-Hardware support in AllScenariOS
-################################
+Hardware support in All Scenario OS
+###################################
This section details the hardware (including virtualized) supported as part of
-AllScenariOS.
+All Scenario OS.
.. toctree::
:maxdepth: 2
diff --git a/docs/hardware-support/virtual-boards/index.rst b/docs/hardware-support/virtual-boards/index.rst
index 67fc4229..134dfff2 100644
--- a/docs/hardware-support/virtual-boards/index.rst
+++ b/docs/hardware-support/virtual-boards/index.rst
@@ -5,7 +5,7 @@
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::
:maxdepth: 1
diff --git a/docs/hardware-support/virtual-boards/qemuarm.rst b/docs/hardware-support/virtual-boards/qemuarm.rst
index abbfe145..182a9528 100644
--- a/docs/hardware-support/virtual-boards/qemuarm.rst
+++ b/docs/hardware-support/virtual-boards/qemuarm.rst
@@ -11,7 +11,7 @@ Qemu ARM
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
===================
@@ -31,9 +31,9 @@ Supported images
* - Image Name
- Description
* - 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 Wayland image including the base OS software stack
+ - All Scenario OS Wayland image including the base OS software stack
Build steps
-----------
diff --git a/docs/hardware-support/virtual-boards/qemuarm64.rst b/docs/hardware-support/virtual-boards/qemuarm64.rst
index 29bdf71d..254655e6 100644
--- a/docs/hardware-support/virtual-boards/qemuarm64.rst
+++ b/docs/hardware-support/virtual-boards/qemuarm64.rst
@@ -11,7 +11,7 @@ Qemu ARM64
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
===================
@@ -31,9 +31,9 @@ Supported images
* - Image Name
- Description
* - 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 Wayland image including the base OS software stack
+ - All Scenario OS Wayland image including the base OS software stack
Build steps
-----------
diff --git a/docs/hardware-support/virtual-boards/qemux86-64.rst b/docs/hardware-support/virtual-boards/qemux86-64.rst
index 48b1fa9e..2c916b7b 100644
--- a/docs/hardware-support/virtual-boards/qemux86-64.rst
+++ b/docs/hardware-support/virtual-boards/qemux86-64.rst
@@ -11,7 +11,7 @@ Qemu X86-64
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
===================
@@ -31,9 +31,9 @@ Supported images
* - Image Name
- Description
* - 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 Wayland image including the base OS software stack
+ - All Scenario OS Wayland image including the base OS software stack
Build steps
-----------
diff --git a/docs/hardware-support/virtual-boards/qemux86.rst b/docs/hardware-support/virtual-boards/qemux86.rst
index e33c2229..16cb7ad8 100644
--- a/docs/hardware-support/virtual-boards/qemux86.rst
+++ b/docs/hardware-support/virtual-boards/qemux86.rst
@@ -11,7 +11,7 @@ Qemu X86
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
===================
@@ -31,9 +31,9 @@ Supported images
* - Image Name
- Description
* - 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 Wayland image including the base OS software stack
+ - All Scenario OS Wayland image including the base OS software stack
Build steps
-----------
diff --git a/docs/repo-workspace.rst b/docs/repo-workspace.rst
index 06841d65..d9cc1f62 100644
--- a/docs/repo-workspace.rst
+++ b/docs/repo-workspace.rst
@@ -7,9 +7,9 @@
Repo Workspace
##############
-AllScenariOS uses `repo <https://android.googlesource.com/tools/repo>`_ to
+All Scenario OS uses `repo <https://android.googlesource.com/tools/repo>`_ to
provide full workspace setup that includes all the repositories needed for
-building AllScenariOS and developing on top.
+building All Scenario OS and developing on top.
.. contents::
:depth: 2
@@ -17,10 +17,10 @@ building AllScenariOS and developing on top.
The Repo Tool
*************
-In order to setup a sources workspace of AllScenariOS, the ``git-repo`` tool is
+In order to setup a sources workspace of All Scenario OS, the ``git-repo`` tool is
required on the host.
-AllScenariOS provides a patched version of the repo tool for ``Ubuntu 20.04``
+All Scenario OS 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 +72,7 @@ Then install the ``repo`` package with pacman.
On OpenMandriva:
----------------
-OpenMandriva has already added AllScenariOS's version of ``repo`` to its official
+OpenMandriva has already added All Scenario OS's version of ``repo`` to its official
repositories. If you're on OpenMandriva, simply ``dnf install repo``.
@@ -91,7 +91,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 AllScenariOS:
+This will bring in all the needed sources for building All Scenario OS:
.. code-block:: console
diff --git a/docs/yocto-build-system/assets/ohos-build-arch.puml b/docs/yocto-build-system/assets/ohos-build-arch.puml
index 732392cc..03257f12 100644
--- a/docs/yocto-build-system/assets/ohos-build-arch.puml
+++ b/docs/yocto-build-system/assets/ohos-build-arch.puml
@@ -6,7 +6,7 @@
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
Person(dev, "Developer", "Anyone willing to build the OHOS based image")
-System(meta_ohos, "meta-ohos", "AllScenariOS OS umbrella bitbake meta-layer")
+System(meta_ohos, "meta-ohos", "All Scenario OS OS umbrella bitbake meta-layer")
Boundary(poky, "poky") {
System_Ext(bitbake, "bitbake", "build process orchestrator")
System_Ext(linux_yocto, "linux-yocto", "Yocto Project LTS linux kernel")
diff --git a/docs/yocto-build-system/index.rst b/docs/yocto-build-system/index.rst
index c8bd49a1..366a8e0e 100644
--- a/docs/yocto-build-system/index.rst
+++ b/docs/yocto-build-system/index.rst
@@ -2,12 +2,12 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
-AllScenariOS, a Yocto-based Build System
-########################################
+All Scenario OS, a Yocto-based Build System
+###########################################
-AllScenariOS build system, the foundation of the build infrastructure, is based
+All Scenario 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/>`_.
-This section details both generic and AllScenariOS specific aspects of the build system.
+This section details both generic and All Scenario OS 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 d3460d43..6feb2d5f 100644
--- a/docs/yocto-build-system/ohos-build-arch.rst
+++ b/docs/yocto-build-system/ohos-build-arch.rst
@@ -2,8 +2,8 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
-AllScenariOS Build Architecture
-###############################
+All Scenario OS Build Architecture
+##################################
``meta-ohos`` architecture is documented using `c4 model <https://c4model.com/>`_.
@@ -13,11 +13,11 @@ AllScenariOS Build Architecture
Overview
********
-AllScenariOS build infrastructure designed to run atop variety of OS kernels
+All Scenario OS build infrastructure designed to run atop variety of OS kernels
ranging from RTOSs to Linux.
``meta-ohos`` is a *umbrella* of meta layers containing build meta-data
-required for compiling AllScenariOS images. The architecture supports plugging
+required for compiling All Scenario OS 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 07aa0662..6c96ba58 100644
--- a/docs/yocto-build-system/yocto-project.rst
+++ b/docs/yocto-build-system/yocto-project.rst
@@ -5,7 +5,7 @@
Poky/Yocto Project
##################
-AllScenariOS aims to use standard opensource tools to create a build environment
+All Scenario 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
requirements of the project. With this in mind, the project build
infrastructure is based on the OpenEmbedded build system, more specifically
@@ -29,10 +29,10 @@ in the build system.
See `terms for reference <https://www.yoctoproject.org/software-overview/>`_
for more information.
-AllScenariOS Build Layers
--------------------------
+All Scenario OS Build Layers
+----------------------------
-AllScenariOS bases its build setup on Poky, the Yocto Project open source
+All Scenario 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/>`_,
a collection of layers with different scopes for defining the project's
requirements and capabilities.
--
GitLab