From a29b1b95b87c2921336212fe1baa16f931b09bb9 Mon Sep 17 00:00:00 2001 From: Zygmunt Krynicki <zygmunt.krynicki@huawei.com> Date: Tue, 20 Apr 2021 13:14:26 +0000 Subject: [PATCH] docs: rename OpenHarmony to AllScenariOS Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@huawei.com> --- docs/Makefile | 2 +- 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/openharmony-quick-build.rst | 14 +++++++------- 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, 69 insertions(+), 69 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index 84fac27d..63bc3068 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -6,7 +6,7 @@ all: sphinx-build -W -C \ -D html_theme=sphinx_rtd_theme \ - -D project='OpenHarmony Build System and meta-ohos' \ + -D project='AllScenariOS Build System and meta-ohos' \ -D copyright='Huawei Inc' \ . build diff --git a/docs/blueprints/index.rst b/docs/blueprints/index.rst index 9b2cf946..3b11bb47 100644 --- a/docs/blueprints/index.rst +++ b/docs/blueprints/index.rst @@ -2,11 +2,11 @@ .. .. SPDX-License-Identifier: CC-BY-4.0 -OpenHarmony Blueprints -###################### +AllScenariOS Blueprints +####################### This section details the available blueprints provided as part of the -OpenHarmony environment. +AllScenariOS environment. .. toctree:: :maxdepth: 1 diff --git a/docs/blueprints/smart-panel.rst b/docs/blueprints/smart-panel.rst index eefd8fb5..14f447d7 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 OpenHarmony 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 AllScenariOS 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 f3c3ab85..1cdb1bc5 100644 --- a/docs/build-flavours/build-flavours.rst +++ b/docs/build-flavours/build-flavours.rst @@ -5,9 +5,9 @@ Overview of Build Flavours ########################## -OpenHarmony can be hosted on top of variety of kernels. Currently supported +AllScenariOS 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 OpenHarmony +requires build configuration that is specific to each kernel and AllScenariOS 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 add6005e..352c7588 100644 --- a/docs/build-flavours/freertos-flavour.rst +++ b/docs/build-flavours/freertos-flavour.rst @@ -5,7 +5,7 @@ FreeRTOS Kernel Build Flavour ############################# -OpenHarmony FreeRTOS build flavour is based on *freertos* distribution (distro configuration). +AllScenariOS 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 a4de7214..9cfba1e6 100644 --- a/docs/build-flavours/index.rst +++ b/docs/build-flavours/index.rst @@ -2,10 +2,10 @@ .. .. SPDX-License-Identifier: CC-BY-4.0 -OpenHarmony Build Flavours -########################## +AllScenariOS Build Flavours +########################### -OpenHarmony provides default build configuration for each supported type of +AllScenariOS 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 2c1d0df3..28a185e3 100644 --- a/docs/build-flavours/linux-flavour.rst +++ b/docs/build-flavours/linux-flavour.rst @@ -5,7 +5,7 @@ Linux Kernel Build Flavour ########################## -OpenHarmony Linux build flavour is based on *openharmony-linux* distribution (distro configuration). +AllScenariOS Linux build flavour is based on *openharmony-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 9985001f..b9757e29 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 OpenHarmony -###################################### +Adding Hardware Support in AllScenariOS +####################################### This section details the addition of new hardware to the supported set in -OpenHarmony. It is intended as a checklist for adding new boards to OHOS build +AllScenariOS. It is intended as a checklist for adding new boards to OHOS build system. -Before starting get familiar with OpenHarmony Contribution Process. +Before starting get familiar with AllScenariOS Contribution Process. .. contents:: :depth: 2 -Select OpenHarmony Flavour -************************** +Select AllScenariOS Flavour +*************************** -OpenHarmony uses a notion of kernel specific flavours: +AllScenariOS 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 -OpenHarmony build system uses ***repo*** tool for cloning required meta-layers +AllScenariOS 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 103cabf4..876c65ca 100644 --- a/docs/hardware-support/boards/96b-Avenger.rst +++ b/docs/hardware-support/boards/96b-Avenger.rst @@ -43,10 +43,10 @@ Supported images - Description * - openharmony-image-base - Approximate 100-200 MB - - OpenHarmony image including the base OS software stack + - AllScenariOS image including the base OS software stack * - openharmony-image-extra - Approximate 100-200 MB - - OpenHarmony Wayland image including the base OS software stack + - AllScenariOS 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 3c468c8c..f57165d3 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 ======================= -OpenHarmony OS Zephyr flavour is based on Zephyr kernel. +AllScenariOS 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 7ec39867..a6147007 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 OpenHarmony. +This section details the boards supported as part of AllScenariOS. .. toctree:: :maxdepth: 1 diff --git a/docs/hardware-support/boards/seco-imx8mm-c61.rst b/docs/hardware-support/boards/seco-imx8mm-c61.rst index 461f4da0..9d342ef6 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 * - openharmony-image-base - Approximate 100-200 MB - - OpenHarmony image including the base OS software stack + - AllScenariOS 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 e2dc84c0..6e4b87b8 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 * - openharmony-image-base - Approximate 100-200 MB - - OpenHarmony image including the base OS software stack + - AllScenariOS image including the base OS software stack * - openharmony-image-extra - Approximate 100-200 MB - - OpenHarmony Wayland image including the base OS software stack + - AllScenariOS 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 7c19d138..39b2d85e 100644 --- a/docs/hardware-support/index.rst +++ b/docs/hardware-support/index.rst @@ -4,11 +4,11 @@ .. _HardwareSupport: -Hardware support in OpenHarmony -############################### +Hardware support in AllScenariOS +################################ This section details the hardware (including virtualized) supported as part of -OpenHarmony. +AllScenariOS. .. toctree:: :maxdepth: 2 diff --git a/docs/hardware-support/virtual-boards/index.rst b/docs/hardware-support/virtual-boards/index.rst index f1d55ccf..67fc4229 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 OpenHarmony. +This section details the support for virtual targets in AllScenariOS. .. toctree:: :maxdepth: 1 diff --git a/docs/hardware-support/virtual-boards/qemuarm.rst b/docs/hardware-support/virtual-boards/qemuarm.rst index 712a04d7..b9c564be 100644 --- a/docs/hardware-support/virtual-boards/qemuarm.rst +++ b/docs/hardware-support/virtual-boards/qemuarm.rst @@ -11,7 +11,7 @@ Qemu ARM Overview ******** -OpenHarmony supports running the software stack into an virtual environment using Qemu. +AllScenariOS supports running the software stack into an virtual environment using Qemu. Building OHOS image =================== @@ -31,9 +31,9 @@ Supported images * - Image Name - Description * - openharmony-image-base - - OpenHarmony image including the base OS software stack + - AllScenariOS image including the base OS software stack * - openharmony-image-extra - - OpenHarmony Wayland image including the base OS software stack + - AllScenariOS 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 d5fc66ce..8ef0d0f4 100644 --- a/docs/hardware-support/virtual-boards/qemuarm64.rst +++ b/docs/hardware-support/virtual-boards/qemuarm64.rst @@ -11,7 +11,7 @@ Qemu ARM64 Overview ******** -OpenHarmony supports running the software stack into an virtual environment using Qemu. +AllScenariOS supports running the software stack into an virtual environment using Qemu. Building OHOS image =================== @@ -31,9 +31,9 @@ Supported images * - Image Name - Description * - openharmony-image-base - - OpenHarmony image including the base OS software stack + - AllScenariOS image including the base OS software stack * - openharmony-image-extra - - OpenHarmony Wayland image including the base OS software stack + - AllScenariOS 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 1ab389f7..9ce41d44 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 ******** -OpenHarmony supports running the software stack into an virtual environment using Qemu. +AllScenariOS supports running the software stack into an virtual environment using Qemu. Building OHOS image =================== @@ -31,9 +31,9 @@ Supported images * - Image Name - Description * - openharmony-image-base - - OpenHarmony image including the base OS software stack + - AllScenariOS image including the base OS software stack * - openharmony-image-extra - - OpenHarmony Wayland image including the base OS software stack + - AllScenariOS 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 fd872579..e4f9ee7c 100644 --- a/docs/hardware-support/virtual-boards/qemux86.rst +++ b/docs/hardware-support/virtual-boards/qemux86.rst @@ -11,7 +11,7 @@ Qemu X86 Overview ******** -OpenHarmony supports running the software stack into an virtual environment using Qemu. +AllScenariOS supports running the software stack into an virtual environment using Qemu. Building OHOS image =================== @@ -31,9 +31,9 @@ Supported images * - Image Name - Description * - openharmony-image-base - - OpenHarmony image including the base OS software stack + - AllScenariOS image including the base OS software stack * - openharmony-image-extra - - OpenHarmony Wayland image including the base OS software stack + - AllScenariOS Wayland image including the base OS software stack Build steps ----------- diff --git a/docs/openharmony-quick-build.rst b/docs/openharmony-quick-build.rst index 9acbd288..678ef713 100644 --- a/docs/openharmony-quick-build.rst +++ b/docs/openharmony-quick-build.rst @@ -2,17 +2,17 @@ .. .. SPDX-License-Identifier: CC-BY-4.0 -.. _OpenHarmonyQuickBuild: +.. _AllScenariOSQuickBuild: -OpenHarmony - Quick Build -######################### +AllScenariOS - Quick Build +########################## -This section will guide you to building your first OpenHarmony image targeting +This section will guide you to building your first AllScenariOS 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 OpenHarmony on a real hardware, checkout the :ref:`Avenger96 support page +of AllScenariOS 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 openharmony-image-base -Booting a Qemu X86-64 target with a OpenHarmony image -***************************************************** +Booting a Qemu X86-64 target with a AllScenariOS image +****************************************************** Once the build is done, you can run a Qemu X86-64 instance as it follows: diff --git a/docs/repo-workspace.rst b/docs/repo-workspace.rst index 18cfd3b7..06841d65 100644 --- a/docs/repo-workspace.rst +++ b/docs/repo-workspace.rst @@ -7,9 +7,9 @@ Repo Workspace ############## -OpenHarmony uses `repo <https://android.googlesource.com/tools/repo>`_ to +AllScenariOS uses `repo <https://android.googlesource.com/tools/repo>`_ to provide full workspace setup that includes all the repositories needed for -building OpenHarmony and developing on top. +building AllScenariOS and developing on top. .. contents:: :depth: 2 @@ -17,10 +17,10 @@ building OpenHarmony and developing on top. The Repo Tool ************* -In order to setup a sources workspace of OpenHarmony, the ``git-repo`` tool is +In order to setup a sources workspace of AllScenariOS, the ``git-repo`` tool is required on the host. -OpenHarmony provides a patched version of the repo tool for ``Ubuntu 20.04`` +AllScenariOS 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 OpenHarmony's version of ``repo`` to its official +OpenMandriva has already added AllScenariOS'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 OpenHarmony: +This will bring in all the needed sources for building AllScenariOS: .. 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 33094667..732392cc 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", "OpenHarmony OS umbrella bitbake meta-layer") +System(meta_ohos, "meta-ohos", "AllScenariOS 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 8bea38de..c8bd49a1 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 -OpenHarmony, a Yocto-based Build System -####################################### +AllScenariOS, a Yocto-based Build System +######################################## -OpenHarmony build system, the foundation of the build infrastructure, is based +AllScenariOS 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 OpenHarmony specific aspects of the build system. +This section details both generic and AllScenariOS 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 b2fe3a3c..d3460d43 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 -OpenHarmony Build Architecture -############################## +AllScenariOS Build Architecture +############################### ``meta-ohos`` architecture is documented using `c4 model <https://c4model.com/>`_. @@ -13,11 +13,11 @@ OpenHarmony Build Architecture Overview ******** -OpenHarmony build infrastructure designed to run atop variety of OS kernels +AllScenariOS 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 OpenHarmony images. The architecture supports plugging +required for compiling AllScenariOS 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 007ff903..07aa0662 100644 --- a/docs/yocto-build-system/yocto-project.rst +++ b/docs/yocto-build-system/yocto-project.rst @@ -5,7 +5,7 @@ Poky/Yocto Project ################## -OpenHarmony aims to use standard opensource tools to create a build environment +AllScenariOS 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. -OpenHarmony Build Layers ------------------------- +AllScenariOS Build Layers +------------------------- -OpenHarmony bases its build setup on Poky, the Yocto Project open source +AllScenariOS 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