Skip to content
Snippets Groups Projects
Commit ceae6e98 authored by Gururaj Shetty's avatar Gururaj Shetty
Browse files

docs: Use definitions for project name


* All project name replaced with tag
* definitions.rst reference added
* Closes: OSTC/OHOS/docs#77

Signed-off-by: default avatarGururaj Shetty <gururaj.shetty@huawei.com>
parent 39bafca8
No related branches found
No related tags found
No related merge requests found
Showing
with 72 additions and 40 deletions
......@@ -2,10 +2,12 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
.. include:: ../../definitions.rst
Supported Boards
################
This section details the boards supported as part of All Scenarios OS.
This section details the boards supported as part of |main_project_name|.
.. toctree::
:maxdepth: 1
......
......@@ -2,6 +2,8 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
.. include:: ../../definitions.rst
.. _SupportedBoardnRF52840DK:
nRF52840 DK
......@@ -30,7 +32,7 @@ Working with the board
Building an application
=======================
All Scenarios OS Zephyr flavour is based on Zephyr kernel.
|main_project_name| Zephyr flavour is based on Zephyr kernel.
1. Source the environment with proper template settings, flavour being ``zephyr``
and target machine being ``nrf52840dk-nrf52840``:
......
......@@ -2,6 +2,8 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
.. include:: ../../definitions.rst
.. _raspberrypi:
Raspberry Pi 4 Model B
......@@ -50,8 +52,8 @@ For more details on the Raspberry Pi 4 board, see `Raspberry Pi hardware page
Working with the board
**********************
Building All Scenarios OS image
===============================
Building |main_project_name| image
==================================
To clone the source code, perform the procedure in: :ref:`Setting up a repo
workspace <RepoWorkspace>`.
......@@ -84,8 +86,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 Scenarios OS Linux Image
*************************************
Flashing |main_project_name| Linux Image
****************************************
SD card
=======
......
......@@ -2,6 +2,8 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
.. include:: ../../definitions.rst
.. _SupportedBoardSecoB68:
SBC-B68-eNUC SECO
......
......@@ -2,13 +2,15 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
.. include:: ../definitions.rst
.. _HardwareSupport:
Hardware support in All Scenarios OS
####################################
Hardware support in |main_project_name|
#######################################
This section details the hardware (including virtualized) supported as part of
All Scenarios OS.
|main_project_name|.
.. toctree::
:maxdepth: 2
......
......@@ -2,10 +2,12 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
.. include:: ../../definitions.rst
Supported Virtual Targets
#########################
This section details the support for virtual targets in All Scenarios OS.
This section details the support for virtual targets in |main_project_name|.
.. toctree::
:maxdepth: 1
......
......@@ -2,6 +2,8 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
.. include:: ../../definitions.rst
Qemu X86-64
###########
......@@ -11,7 +13,7 @@ Qemu X86-64
Overview
********
All Scenarios OS supports running the software stack into an virtual environment using Qemu.
|main_project_name| supports running the software stack into an virtual environment using Qemu.
Building OHOS image
===================
......
......@@ -2,6 +2,8 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
.. include:: ../../definitions.rst
Qemu X86
########
......@@ -11,7 +13,7 @@ Qemu X86
Overview
********
All Scenarios OS supports running the software stack into an virtual environment using Qemu.
|main_project_name| supports running the software stack into an virtual environment using Qemu.
Building OHOS image
===================
......
......@@ -2,10 +2,12 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
.. include:: ../definitions.rst
Operating System
################
All Scenarios OS provides support for a set of kernels. This documentation
|main_project_name| provides support for a set of kernels. This documentation
details various aspects for each kernel type.
.. toctree::
......
......@@ -2,8 +2,10 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
All Scenarios OS - Linux
########################
.. include:: ../../definitions.rst
|main_project_name| - Linux
###########################
.. toctree::
:maxdepth: 1
......
......@@ -2,12 +2,14 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
.. include:: ../../definitions.rst
.. _SupportedTechnologies:
Supported Technologies
######################
This section details the supported technologies in All Scenarios OS.
This section details the supported technologies in |main_project_name|.
.. toctree::
:maxdepth: 1
......
......@@ -2,14 +2,16 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
.. include:: definitions.rst
.. _RepoWorkspace:
Repo Workspace
##############
All Scenarios OS uses `repo <https://android.googlesource.com/tools/repo>`_ to
|main_project_name| uses `repo <https://android.googlesource.com/tools/repo>`_ to
provide full workspace setup that includes all the repositories needed for
building All Scenarios OS and developing on top.
building |main_project_name| and developing on top.
.. contents::
:depth: 2
......@@ -17,10 +19,10 @@ building All Scenarios OS and developing on top.
The Repo Tool
*************
In order to setup a sources workspace of All Scenarios OS, the ``git-repo`` tool is
In order to setup a sources workspace of |main_project_name|, the ``git-repo`` tool is
required on the host.
All Scenarios OS provides a patched version of the repo tool for ``Ubuntu 20.04``
|main_project_name| 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 +74,7 @@ Then install the ``repo`` package with pacman.
On OpenMandriva:
----------------
OpenMandriva has already added All Scenarios OS's version of ``repo`` to its official
OpenMandriva has already added |main_project_name| version of ``repo`` to its official
repositories. If you're on OpenMandriva, simply ``dnf install repo``.
......@@ -91,7 +93,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 Scenarios OS:
This will bring in all the needed sources for building |main_project_name|:
.. code-block:: console
......
......@@ -2,11 +2,13 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
.. include:: definitions.rst
Supported Images
################
To create a custom Linux distribution to match the product requirements,
All Scenarios OS includes a set of predefined images for developing a product image.
|main_project_name| includes a set of predefined images for developing a product image.
Linux Kernel
************
......@@ -14,7 +16,7 @@ Linux Kernel
The Linux kernel is a free and open-source Unix-like operating system (OS)
kernel that serves as the primary interface between the computer's hardware and its processes.
All Scenarios OS supports the following images listed in the table:
|main_project_name| supports the following images listed in the table:
.. list-table:: Linux supported images
:header-rows: 1
......@@ -23,11 +25,11 @@ All Scenarios OS supports the following images listed in the table:
- Description
* - allscenarios-image-base
-
* All Scenarios OS image including the base OS software stack.
* |main_project_name| image including the base OS software stack.
* This image also includes middleware and application packages to support a wide range of hardware which includes WiFi, Bluetooth, sound, and serial ports.
* - allscenarios-image-extra
-
* All Scenarios OS Wayland image including the base OS software stack. This is a Wayland protocol and Weston reference compositor-based image.
* |main_project_name| Wayland image including the base OS software stack. This is a Wayland protocol and Weston reference compositor-based image.
* It uses the Wayland protocol and implementation to exchange data with its clients.
* This image provides the Wayland protocol libraries and the reference Weston compositor and includes a Wayland-capable terminal program.
......@@ -41,7 +43,7 @@ that is intended for use on resource-constrained and embedded systems.
For more detailed information on Zephyr OS Kernel, see `Zephyr documentation <https://docs.zephyrproject.org/latest/index.html#>`_.
All Scenarios OS supports the following images for the Zephyr OS kernel:
|main_project_name| supports the following images for the Zephyr OS kernel:
.. list-table:: Zephyr supported images
:header-rows: 1
......@@ -60,7 +62,7 @@ The FreeRTOS kernel is a real-time operating system (RTOS) that runs on a variet
of platforms which is used to build microcontroller-based embedded applications.
The standard RTOS kernel binary image ranges from 4000 to 9000 bytes.
All Scenarios OS supports the following images for FreeRTOS Kernel:
|main_project_name| supports the following images for FreeRTOS Kernel:
.. list-table:: FreeRTOS supported images
:header-rows: 1
......
......@@ -2,12 +2,14 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
All Scenarios OS, a Yocto-based Build System
############################################
.. include:: ../definitions.rst
All Scenarios OS build system, the foundation of the build infrastructure, is based
|main_project_name|, a Yocto-based Build System
###############################################
|main_project_name| 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 Scenarios OS specific aspects of the build system.
This section details both generic and |main_project_name| specific aspects of the build system.
.. toctree::
:maxdepth: 1
......
......@@ -2,8 +2,10 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
All Scenarios OS Build Architecture
###################################
.. include:: ../definitions.rst
|main_project_name| Build Architecture
######################################
``meta-ohos`` architecture is documented using `c4 model <https://c4model.com/>`_.
......@@ -13,11 +15,11 @@ All Scenarios OS Build Architecture
Overview
********
All Scenarios OS build infrastructure is designed to run atop variety of OS kernels
|main_project_name| build infrastructure is designed to run atop variety of OS kernels
ranging from RTOSes to Linux.
``meta-ohos`` is an *umbrella* of meta layers containing build's meta-data
required for compiling All Scenarios OS images. The architecture supports plugging
required for compiling |main_project_name| images. The architecture supports plugging
various kernels.
.. image:: assets/meta-ohos-arch.png
......@@ -2,10 +2,12 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
.. include:: ../definitions.rst
Poky/Yocto Project
##################
All Scenarios OS aims to use standard opensource tools to create a build environment
|main_project_name| 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 +31,10 @@ in the build system.
See `terms for reference <https://www.yoctoproject.org/software-overview/>`_
for more information.
All Scenarios OS Build Layers
-----------------------------
|main_project_name| Build Layers
--------------------------------
All Scenarios OS bases its build setup on Poky, the Yocto Project open source
|main_project_name| 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.
......
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