diff --git a/docs/Makefile b/docs/Makefile index 63bc30681922369095fac8940a5efd741747ff49..ac87306d83bf53789e4da954d07c0ce551009d33 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 d4f64a1b8421ee548d5d44352b9463b5d0f0c354..87aa6f3d7c19f61a7d06b04c01d8d11358c2eb06 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 3b11bb47abf53dd08266472113c4366d61833206..9f20496bac335fc670988fa86c74276538a2af89 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 5e3ae268c6ef5a574011753e1c63781e9fdf64ab..f056a70baf8e4988cebf4e899ffd66f55017891f 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 1cdb1bc5e222b6337256f5548e1c24454a28e723..1f33fe2ba9f329b973ff3d9bfe1f7705427e271c 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 352c75889a7f45e482847ee9c16163748fa2e52c..bdfda9cae7e9daf00e2dc6d6fbcaeecbc1e2392e 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 9cfba1e67c100ca2ac4a6ea697ca5c703e19bae8..8579a764237a77d059b13c01b0a7aafc3f14d1f9 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 04de9eefeebc5e673f986d4d4c15ec995f4d88c3..036b31efce77e1bf18c3e89acce19ab649235d13 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 b9757e293aae85aadaf32af78a69b03b0971319b..fb879740692907355c6de7e0df2591fedff84440 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 b77169929b7dff1fd1d22fcea5c1cdf00d6ddb24..3c4dcd6ff7a6eb527856bad96a651e516a451076 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 f57165d3f0826b5021ab8da92a9dd59d0b3b9e97..b538f1eec7b90b38d93c3836686687fbafba806a 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 a6147007a0e40477241b7de5000a869c06a125e1..a0a144d589a7df62dd88c8204098c8ab9a814518 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 4b92be75c65ca624fdd6b0777861edc59538c794..266d0083d26beed48eab3b0fe0271267e97ada8a 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 5b88f9c311ab47e253d3e72ea673a92d09d23e42..c6f9ce3e281841783bc028620ba763028ac6c652 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 39b2d85ee2d3beae4f4316d217cea142257d4e19..74f103ffe6517c7f244dc3f64e3c5949823b352a 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 67fc42291839e826da2ee8706807f5adbffee15b..134dfff22257a039b8549ed5a4c6506ced0563f2 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 abbfe14579cbacecc1d3c1a12df2a5e04da4164b..182a9528342b03c8c252a2c7458deb666c53eaf6 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 29bdf71d0a483eea8f80c5a589c05320cff65f49..254655e67bd8af26346967f65adb7ea4f57250ce 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 48b1fa9ec9b2e71413aac02548878689db4091d2..2c916b7b78fbfee9dc553d72758e13c443ef65f2 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 e33c22291ade217798f7c08153c8f8a15ff7789b..16cb7ad82604573d09b03ab237b92cd49d9c6b99 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 06841d6582dadacddbefeff067a3928742771902..d9cc1f625f52c7d1027478d3b81f8ef2314cfa15 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 732392cc3bb149902cec4ddb5182e7efe3932f7e..03257f127078af6a41ce9f232b45fca06edab4fe 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 c8bd49a174e478ba877c7e06178080d87c04b315..366a8e0e38fbbbc6fcb30ddfa86b72b490f77ec3 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 d3460d4375ef4952085d7c85aac50ff541e47eed..6feb2d5fa525ec8208e6b36b2855e1c8a945133a 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 07aa0662b846c8eea450a8b90fd1380fbfae827d..6c96ba5882e679b6febc1b2d57ef67bf9381a7e3 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.