From 5c9218cd10ecadcbcc87624cd518676ae49c5a39 Mon Sep 17 00:00:00 2001
From: Arul Kumaran <arulkumaran.devarajan@huawei.com>
Date: Mon, 3 May 2021 12:33:50 +0530
Subject: [PATCH] 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: Arul Kumaran <arulkumaran.devarajan@huawei.com>
---
docs/allscenarios-quick-build.rst | 12 ++++++------
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/raspberrypi4.rst | 12 ++++++------
docs/hardware-support/boards/seco-imx8mm-c61.rst | 2 +-
docs/hardware-support/boards/seco-intel-b68.rst | 4 ++--
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 ++++++------
docs/yocto-build-system/index.rst | 8 ++++----
docs/yocto-build-system/ohos-build-arch.rst | 8 ++++----
docs/yocto-build-system/yocto-project.rst | 8 ++++----
19 files changed, 63 insertions(+), 63 deletions(-)
diff --git a/docs/allscenarios-quick-build.rst b/docs/allscenarios-quick-build.rst
index bb3b0db6..5edad3c4 100644
--- a/docs/allscenarios-quick-build.rst
+++ b/docs/allscenarios-quick-build.rst
@@ -4,15 +4,15 @@
.. _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
booting such an image.
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>`.
.. contents::
@@ -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
$ 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:
diff --git a/docs/build-flavours/build-flavours.rst b/docs/build-flavours/build-flavours.rst
index 1f33fe2b..9fbf57d7 100644
--- a/docs/build-flavours/build-flavours.rst
+++ b/docs/build-flavours/build-flavours.rst
@@ -5,9 +5,9 @@
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
-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>`_
for more info about the underlying mechanism.
diff --git a/docs/build-flavours/freertos-flavour.rst b/docs/build-flavours/freertos-flavour.rst
index bdfda9ca..18a28b99 100644
--- a/docs/build-flavours/freertos-flavour.rst
+++ b/docs/build-flavours/freertos-flavour.rst
@@ -5,7 +5,7 @@
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:
diff --git a/docs/build-flavours/index.rst b/docs/build-flavours/index.rst
index 8579a764..d0f8a699 100644
--- a/docs/build-flavours/index.rst
+++ b/docs/build-flavours/index.rst
@@ -2,10 +2,10 @@
..
.. 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``.
.. toctree::
diff --git a/docs/build-flavours/linux-flavour.rst b/docs/build-flavours/linux-flavour.rst
index 036b31ef..2ffaf6b7 100644
--- a/docs/build-flavours/linux-flavour.rst
+++ b/docs/build-flavours/linux-flavour.rst
@@ -5,7 +5,7 @@
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:
diff --git a/docs/hardware-support/adding-hardware-support.rst b/docs/hardware-support/adding-hardware-support.rst
index fb879740..ffe3cc2f 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 All Scenario OS
-##########################################
+Adding Hardware Support in All Scenarios OS
+###########################################
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.
-Before starting get familiar with All Scenario OS Contribution Process.
+Before starting get familiar with All Scenarios OS Contribution Process.
.. contents::
: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
- Zephyr flavour
@@ -47,7 +47,7 @@ directory) consist of the following files:
* 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>`).
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 3c4dcd6f..7b16a94b 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
- - All Scenario OS image including the base OS software stack
+ - All Scenarios OS image including the base OS software stack
* - allscenarios-image-extra
- 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
diff --git a/docs/hardware-support/boards/96b-nitrogen.rst b/docs/hardware-support/boards/96b-nitrogen.rst
index b538f1ee..9a4985e6 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
=======================
-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:
diff --git a/docs/hardware-support/boards/raspberrypi4.rst b/docs/hardware-support/boards/raspberrypi4.rst
index 2b83c4ce..487b8714 100644
--- a/docs/hardware-support/boards/raspberrypi4.rst
+++ b/docs/hardware-support/boards/raspberrypi4.rst
@@ -60,12 +60,12 @@ Supported images
* - Image Name
- Description
* - 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
- - 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
workspace <RepoWorkspace>`.
@@ -98,8 +98,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 Scenario OS Linux Image
-************************************
+Flashing All Scenarios OS Linux Image
+*************************************
SD card
=======
diff --git a/docs/hardware-support/boards/seco-imx8mm-c61.rst b/docs/hardware-support/boards/seco-imx8mm-c61.rst
index 266d0083..23463e23 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
- - All Scenario OS image including the base OS software stack
+ - All Scenarios 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 c6f9ce3e..08dd1dcc 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
- - All Scenario OS image including the base OS software stack
+ - All Scenarios OS image including the base OS software stack
* - allscenarios-image-extra
- 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
diff --git a/docs/hardware-support/virtual-boards/qemuarm.rst b/docs/hardware-support/virtual-boards/qemuarm.rst
index 182a9528..fcd3a88f 100644
--- a/docs/hardware-support/virtual-boards/qemuarm.rst
+++ b/docs/hardware-support/virtual-boards/qemuarm.rst
@@ -11,7 +11,7 @@ Qemu ARM
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
===================
@@ -31,9 +31,9 @@ Supported images
* - Image Name
- Description
* - 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
- - All Scenario OS Wayland image including the base OS software stack
+ - All Scenarios 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 254655e6..ba848fe6 100644
--- a/docs/hardware-support/virtual-boards/qemuarm64.rst
+++ b/docs/hardware-support/virtual-boards/qemuarm64.rst
@@ -11,7 +11,7 @@ Qemu ARM64
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
===================
@@ -31,9 +31,9 @@ Supported images
* - Image Name
- Description
* - 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
- - All Scenario OS Wayland image including the base OS software stack
+ - All Scenarios 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 2c916b7b..8beac404 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
********
-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
===================
@@ -31,9 +31,9 @@ Supported images
* - Image Name
- Description
* - 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
- - All Scenario OS Wayland image including the base OS software stack
+ - All Scenarios 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 16cb7ad8..b38a7657 100644
--- a/docs/hardware-support/virtual-boards/qemux86.rst
+++ b/docs/hardware-support/virtual-boards/qemux86.rst
@@ -11,7 +11,7 @@ Qemu X86
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
===================
@@ -31,9 +31,9 @@ Supported images
* - Image Name
- Description
* - 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
- - All Scenario OS Wayland image including the base OS software stack
+ - All Scenarios OS Wayland image including the base OS software stack
Build steps
-----------
diff --git a/docs/repo-workspace.rst b/docs/repo-workspace.rst
index d9cc1f62..38d59d51 100644
--- a/docs/repo-workspace.rst
+++ b/docs/repo-workspace.rst
@@ -7,9 +7,9 @@
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
-building All Scenario OS and developing on top.
+building All Scenarios OS and developing on top.
.. contents::
:depth: 2
@@ -17,10 +17,10 @@ building All Scenario OS and developing on top.
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.
-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>`_,
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 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``.
@@ -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 All Scenario OS:
+This will bring in all the needed sources for building All Scenarios OS:
.. code-block:: console
diff --git a/docs/yocto-build-system/index.rst b/docs/yocto-build-system/index.rst
index 366a8e0e..cd439bd5 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
-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/>`_.
-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::
:maxdepth: 1
diff --git a/docs/yocto-build-system/ohos-build-arch.rst b/docs/yocto-build-system/ohos-build-arch.rst
index 6feb2d5f..9cda4b92 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
-All Scenario OS Build Architecture
-##################################
+All Scenarios OS Build Architecture
+###################################
``meta-ohos`` architecture is documented using `c4 model <https://c4model.com/>`_.
@@ -13,11 +13,11 @@ All Scenario OS Build Architecture
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.
``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.
.. 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 6c96ba58..b579624b 100644
--- a/docs/yocto-build-system/yocto-project.rst
+++ b/docs/yocto-build-system/yocto-project.rst
@@ -5,7 +5,7 @@
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
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.
-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/>`_,
a collection of layers with different scopes for defining the project's
requirements and capabilities.
--
GitLab