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

docs: Project Rename


* Project rename
* adr directory removed
* Closes distro/docs#77

Signed-off-by: default avatarGururaj Shetty <gururaj.shetty@huawei.com>
parent 82d09849
No related branches found
No related tags found
No related merge requests found
Showing
with 59 additions and 57 deletions
......@@ -73,18 +73,18 @@ Linux image
./oe-core/oe-init-build-env build-oniro-linux-raspberrypi4-64
2. You will find yourself in the newly created build directory. Call *bitbake*
to build the image. For example, if you are using *allscenarios-image-base*
to build the image. For example, if you are using *oniro-image-base*
run the following command:
.. code-block:: console
$ MACHINE=raspberrypi4-64 bitbake allscenarios-image-base
$ MACHINE=raspberrypi4-64 bitbake oniro-image-base
3. After the build completes, the bootloader, kernel, and rootfs image files
can be found in
``build-oniro-linux-raspberrypi4-64/tmp/deploy/images/$MACHINE/``.
The key file which is needed to flash into the SD card is
``allscenarios-image-base-raspberrypi4-64.wic.bz2``.
``oniro-image-base-raspberrypi4-64.wic.bz2``.
Flashing |main_project_name| Linux Image
****************************************
......@@ -98,13 +98,13 @@ describes booting the board with an SD card option.
1. After the image is built, you are ready to burn the generated image onto the
SD card. We recommend using `bmaptool <https://github.com/intel/bmap-tools>`
and the instructions below will use it. For example, if you are building
allscenarios-image-base run the following command replacing (or defining)
oniro-image-base run the following command replacing (or defining)
``$DEVNODE`` accordingly:
.. code-block:: console
$ cd tmp/deploy/images/raspberrypi4-64
$ bmaptool copy allscenarios-image-base-raspberrypi4-64.wic.bz2 $DEVNODE
$ bmaptool copy oniro-image-base-raspberrypi4-64.wic.bz2 $DEVNODE
2. Put the card to the board and turn it on.
......
......@@ -29,8 +29,8 @@ For more detailed specifications of SBC-C61 SECO board, see `SBC-C61 Specificati
Working with the board
**********************
Building OHOS image
===================
Building an Oniro image
=======================
To clone the source code, perform the procedure in: :ref:`Setting up a repo workspace <RepoWorkspace>`.
......@@ -43,16 +43,16 @@ Linux image
$ TEMPLATECONF=../oniro/flavours/linux . ./oe-core/oe-init-build-env build-oniro-linux
2. You will find yourself in the newly created build directory. Call ``bitbake`` to build the image. The supported image is ``allscenarios-image-base``.
2. You will find yourself in the newly created build directory. Call ``bitbake`` to build the image. The supported image is ``oniro-image-base``.
.. code-block:: console
$ MACHINE=seco-imx8mm-c61 bitbake allscenarios-image-base
$ MACHINE=seco-imx8mm-c61 bitbake oniro-image-base
To generate images for eMMC, refer to the following flashing procedure.
Flashing OHOS image
*******************
Flashing an Oniro image
***********************
Linux image
===========
......@@ -67,7 +67,8 @@ MMC Storage
* Download and install `mfgtools <https://github.com/NXPmicro/mfgtools>`__
* Linux Host
To flash OHOS using USB to OTG adapter, perform the following steps:
To flash Oniro image using USB to OTG adapter, perform the
following steps:
#. Short circuit pin 1 and 2 of CN52 pin header to enter the Serial Download mode.
#. Connect USB to OTG adapter to your host PC
......@@ -81,13 +82,13 @@ To flash OHOS using USB to OTG adapter, perform the following steps:
.. code-block:: console
$ gzip -d allscenarios-image-base-seco-imx8mm-c61.wic.gz
$ gzip -d oniro-image-base-seco-imx8mm-c61.wic.gz
#. To write uboot and image(p1:kernel, p2:dtb, rootfs) into c61 mmc via mfgtools:
.. code-block:: console
$ sudo uuu -b emmc_all imx-boot-seco-imx8mm-c61-emmc.bin-flash_evk allscenarios-image-base-seco-imx8mm-c61.wic
$ sudo uuu -b emmc_all imx-boot-seco-imx8mm-c61-emmc.bin-flash_evk oniro-image-base-seco-imx8mm-c61.wic
#. Power ON SBC-C61
#. Remove **CN52 short circuit**
......
......@@ -30,8 +30,8 @@ For more detailed specifications of SBC-B68-eNUC SECO board, see `SBC-B68-eNUC S
Working with the board
**********************
Building Oniro image
====================
Building an Oniro image
=======================
To clone the source code, perform the procedure in: :ref:`Setting up a repo workspace <RepoWorkspace>`.
......@@ -44,16 +44,16 @@ Linux image
$ TEMPLATECONF=../oniro/flavours/linux . ./oe-core/oe-init-build-env build-oniro-linux
2. You will find yourself in the newly created build directory. Call *bitbake* to build the image. For example, if you are using *allscenarios-image-base* run the following command:
2. You will find yourself in the newly created build directory. Call *bitbake* to build the image. For example, if you are using *oniro-image-base* run the following command:
.. code-block:: console
$ MACHINE=seco-intel-b68 bitbake allscenarios-image-base
$ MACHINE=seco-intel-b68 bitbake oniro-image-base
To generate images for SSD Disk, refer to the following flashing OHOS image section.
To generate images for SSD Disk, refer to the following Flashing an Oniro image section.
Flashing OHOS image
*******************
Flashing an Oniro image
***********************
.. _linux-image-2:
......@@ -70,26 +70,27 @@ USB Storage
* USB Storage
* Linux Host
To flash OHOS using USB storage, perform the following steps:
To flash Oniro image using USB storage, perform the following
steps:
**Prepare OHOS bootable USB**
**Prepare an Oniro Bootable USB Stick**
1. Connect USB storage to your host PC.
2. After the image is built, you are ready to burn the generated image onto the
USB storage. We recommend using `bmaptool <https://github.com/intel/bmap-tools>`
and the instructions below will use it. For example, if you are building
allscenarios-image-base run the following command replacing (or defining)
oniro-image-base run the following command replacing (or defining)
``$DEVNODE`` accordingly:
.. code-block:: console
$ cd tmp/deploy/images/seco-intel-b68
$ bmaptool copy allscenarios-image-base-seco-intel-b68.wic.bz2 $DEVNODE
$ bmaptool copy oniro-image-base-seco-intel-b68.wic.bz2 $DEVNODE
3. Put the card to the board and turn it on.
**Run OHOS**
**Run Oniro image**
#. Connect bootable USB to target
......
......@@ -15,8 +15,8 @@ Overview
|main_project_name| supports running the software stack into an virtual environment using Qemu.
Building OHOS image
===================
Building an Oniro image
=======================
To clone the source code, perform the procedure in: :ref:`Setting up a repo workspace <RepoWorkspace>`.
......@@ -29,23 +29,23 @@ Build steps
1. Source the environment with proper template settings, flavour being *linux*
and target machine being *qemux86-64*. Pay attention to how relative paths are
constructed. The value of *TEMPLATECONF* is relative to the location of the
build directory *./build-ohos-linux*, that is going to be created after
build directory *./build-oniro-linux*, that is going to be created after
this step:
.. code-block:: console
$ TEMPLATECONF=../oniro/flavours/linux . ./oe-core/oe-init-build-env build-ohos-linux
$ TEMPLATECONF=../oniro/flavours/linux . ./oe-core/oe-init-build-env build-oniro-linux
2. You will find yourself in the newly created build directory. Call *bitbake*
to build the image. For example, if you are using *allscenarios-image-base*
to build the image. For example, if you are using *oniro-image-base*
run the following command:
.. code-block:: console
$ MACHINE=qemux86-64 bitbake allscenarios-image-base
$ MACHINE=qemux86-64 bitbake oniro-image-base
Once the image is done, you can run the Qemu using the provided script wrapper:
.. code-block:: console
$ MACHINE=qemux86-64 runqemu allscenarios-image-base wic
$ MACHINE=qemux86-64 runqemu oniro-image-base wic
......@@ -15,8 +15,8 @@ Overview
|main_project_name| supports running the software stack into an virtual environment using Qemu.
Building OHOS image
===================
Building an Oniro image
=======================
To clone the source code, perform the procedure in: :ref:`Setting up a repo workspace <RepoWorkspace>`.
......@@ -29,23 +29,23 @@ Build steps
1. Source the environment with proper template settings, flavour being *linux*
and target machine being *qemux86*. Pay attention to how relative paths are
constructed. The value of *TEMPLATECONF* is relative to the location of the
build directory *./build-ohos-linux*, that is going to be created after
build directory *./build-oniro-linux*, that is going to be created after
this step:
.. code-block:: console
$ TEMPLATECONF=../oniro/flavours/linux . ./oe-core/oe-init-build-env build-ohos-linux
$ TEMPLATECONF=../oniro/flavours/linux . ./oe-core/oe-init-build-env build-oniro-linux
2. You will find yourself in the newly created build directory. Call *bitbake*
to build the image. For example, if you are using *allscenarios-image-base*
to build the image. For example, if you are using *oniro-image-base*
run the following command:
.. code-block:: console
$ MACHINE=qemux86 bitbake allscenarios-image-base
$ MACHINE=qemux86 bitbake oniro-image-base
Once the image is done, you can run the Qemu using the provided script wrapper:
.. code-block:: console
$ MACHINE=qemux86 runqemu allscenarios-image-base wic
$ MACHINE=qemux86 runqemu oniro-image-base wic
......@@ -8,7 +8,7 @@ Build System Guide
.. toctree::
:maxdepth: 1
allscenarios-quick-build
oniro-quick-build
yocto-build-system/index
repo-workspace
build-flavours/index
......
......@@ -4,7 +4,7 @@
.. include:: definitions.rst
.. _AllScenariOSQuickBuild:
.. _OniroQuickBuild:
|main_project_name| - Quick Build
#################################
......@@ -55,10 +55,10 @@ Initialize a repo workspace and clone all required repositories:
$ repo init -u https://git.ostc-eu.org/distro/oniro
$ repo sync --no-clone-bundle
Build the allscenarios-image-base image
***************************************
Building an Oniro image
***********************
The following steps will build a ``allscenarios-image-base``. The process will
The following steps will build a ``oniro-image-base``. The process will
build all its components, including the toolchain, from source.
First of all change directory into the one where the build repositories were
......@@ -75,7 +75,7 @@ Initialize the build directory and run a build:
.. code-block:: console
$ TEMPLATECONF=../oniro/flavours/linux . ./oe-core/oe-init-build-env build-oniro-linux
$ MACHINE=qemux86-64 bitbake allscenarios-image-base
$ MACHINE=qemux86-64 bitbake oniro-image-base
Booting a Qemu X86-64 target with a |main_project_name| image
*************************************************************
......@@ -84,7 +84,7 @@ Once the image is built, you can run a Qemu X86-64 instance using the provided s
.. code-block:: console
$ MACHINE=qemux86-64 runqemu allscenarios-image-base wic
$ MACHINE=qemux86-64 runqemu oniro-image-base wic
If the host has a VT-capable CPU, you can pass the ``kvm`` argument for better
performance. Check ``runqemu``'s help message for all available arguments.
......@@ -23,11 +23,11 @@ kernel that serves as the primary interface between the computer's hardware and
* - Image Name
- Description
* - allscenarios-image-base
* - oniro-image-base
-
* |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
* - oniro-image-extra
-
* |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.
......
......@@ -2,11 +2,11 @@
'
' SPDX-License-Identifier: CC-BY-4.0
@startuml meta-ohos-arch
@startuml meta-oniro-arch
!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", "All Scenario OS OS umbrella bitbake meta-layer")
Person(dev, "Developer", "Anyone willing to build the Oniro Operating System")
System(oniro, "oniro", "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")
......@@ -19,10 +19,10 @@ System_Ext(linux_yocto, "linux-yocto", "Yocto Project LTS linux kernel")
System_Ext(meta_external_toolchain, "meta-external-toolchain", "Yocto Project LTS GNU GCC and LLVM toolchains")
Rel(dev, bitbake, "selects configuration, initiates the build, deploys image to the target")
Rel(bitbake, meta_ohos, "incorporates meta-layers relevant for selected kernel / configuration")
Rel(bitbake, oniro, "incorporates meta-layers relevant for selected kernel / configuration")
Rel(bitbake, linux_yocto, "incorporates Yocto Project LTS linux kernel reference")
Rel(bitbake, meta_external_toolchain, "incorporates Yocto Project LTS toolchains")
Rel(bitbake, meta_zephyr, "incorporates for OHOS on Zephyr build")
Rel(bitbake, meta_freertos, "incorporates for OHOS on FreeRTOS build")
Rel(bitbake, meta_zephyr, "incorporates for Oniro Operating System on Zephyr build")
Rel(bitbake, meta_freertos, "incorporates for Oniro Operating System on FreeRTOS build")
@enduml
......@@ -15,4 +15,4 @@ This section details both generic and |main_project_name| specific aspects of th
:maxdepth: 1
yocto-project
ohos-build-arch
oniro-build-arch
......@@ -22,4 +22,4 @@ ranging from RTOSes to Linux.
required for compiling |main_project_name| images. The architecture supports plugging
various kernels.
.. image:: assets/meta-ohos-arch.png
.. image:: assets/oniro-arch.png
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