Skip to content
Snippets Groups Projects
Verified Commit bd3bf7a5 authored by Andrei Gherzan's avatar Andrei Gherzan :penguin:
Browse files

docs: Address meta-ohos repository and default branch rename 


Signed-off-by: Andrei Gherzan's avatarAndrei Gherzan <andrei.gherzan@huawei.com>
parent db0de7f3
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 83 additions and 89 deletions
docs/README.md
+ 3
− 3
View file @ bd3bf7a5
...@@ -4,10 +4,10 @@ SPDX-FileCopyrightText: Huawei Inc. ...@@ -4,10 +4,10 @@ SPDX-FileCopyrightText: Huawei Inc.
SPDX-License-Identifier: CC-BY-4.0 SPDX-License-Identifier: CC-BY-4.0
--> -->
# Documentation for meta-ohos # Documentation for Oniro build repository
The documentation for `meta-ohos` is written as reST files and can be generated The documentation for `oniro` build repository is written as reST files and can
by using standard make targets: be generated by using standard make targets:
``` ```
make make
......
docs/allscenarios-quick-build.rst
+ 3
− 3
View file @ bd3bf7a5
...@@ -51,8 +51,8 @@ Initialize a repo workspace and clone all required repositories: ...@@ -51,8 +51,8 @@ Initialize a repo workspace and clone all required repositories:
.. code-block:: console .. code-block:: console
$ mkdir ohos; cd ohos $ mkdir oniroproject; cd oniroproject
$ repo init -u https://git.ostc-eu.org/OSTC/OHOS/manifest.git -b develop $ repo init -u https://git.ostc-eu.org/distro/oniro
$ repo sync --no-clone-bundle $ repo sync --no-clone-bundle
Build the allscenarios-image-base image Build the allscenarios-image-base image
...@@ -73,7 +73,7 @@ Initialize the build directory and run a build: ...@@ -73,7 +73,7 @@ Initialize the build directory and run a build:
.. code-block:: console .. code-block:: console
$ TEMPLATECONF=../sources/meta-ohos/flavours/linux . ./sources/poky/oe-init-build-env build-ohos-linux $ TEMPLATECONF=../oniro/flavours/linux . ./oe-core/oe-init-build-env build-oniro-linux
$ MACHINE=qemux86-64 bitbake allscenarios-image-base $ MACHINE=qemux86-64 bitbake allscenarios-image-base
Booting a Qemu X86-64 target with a |main_project_name| image Booting a Qemu X86-64 target with a |main_project_name| image
......
docs/blueprints/smart-panel.rst
+ 11
− 13
View file @ bd3bf7a5
...@@ -143,7 +143,7 @@ Get sources ...@@ -143,7 +143,7 @@ Get sources
.. code-block:: bash .. code-block:: bash
user@pc:~/ohos$ repo sync -d $ repo sync -d
Prepare IoT devices (Nitrogen/Zephyr flavour) Prepare IoT devices (Nitrogen/Zephyr flavour)
********************************************* *********************************************
...@@ -156,7 +156,7 @@ Build ...@@ -156,7 +156,7 @@ Build
.. code-block:: bash .. code-block:: bash
$ TEMPLATECONF=../sources/meta-ohos/flavours/zephyr . ./sources/poky/oe-init-build-env build-ohos-zephyr-96b-nitrogen $ TEMPLATECONF=../oniro/flavours/zephyr . ./oe-core/oe-init-build-env build-oniro-zephyr-96b-nitrogen
#. #.
Edit ``conf/local.conf``, and uncomment the following line: Edit ``conf/local.conf``, and uncomment the following line:
...@@ -222,7 +222,7 @@ Flash ...@@ -222,7 +222,7 @@ Flash
.. code-block:: bash .. code-block:: bash
user@pc:~/ohos/build-ohos-zephyr-96b-nitrogen$ pyocd list $ pyocd list
# Probe Unique ID # Probe Unique ID
--------------------------------------------------- ---------------------------------------------------
0 Arch BLE [nrf51] 9009022103BB2A02FE6545F3 0 Arch BLE [nrf51] 9009022103BB2A02FE6545F3
...@@ -243,16 +243,16 @@ Flash ...@@ -243,16 +243,16 @@ Flash
.. code-block:: bash .. code-block:: bash
user@pc:~/ohos/build-ohos-zephyr-96b-nitrogen$ BB_ENV_EXTRAWHITE="$BB_ENV_EXTRAWHITE PYOCD_FLASH_IDS" \ $ BB_ENV_EXTRAWHITE="$BB_ENV_EXTRAWHITE PYOCD_FLASH_IDS" \
PYOCD_FLASH_IDS="9009022103BB2A02FE6545F3" bitbake zephyr-blueprint-smarthome-sensors -c flash_usb PYOCD_FLASH_IDS="9009022103BB2A02FE6545F3" bitbake zephyr-blueprint-smarthome-sensors -c flash_usb
#. #.
Flash the other board with ``zephyr-blueprint-smarthome-switch`` image Flash the other board with ``zephyr-blueprint-smarthome-switch`` image
.. code-block:: bash .. code-block:: bash
user@pc:~/ohos/build-ohos-zephyr-96b-nitrogen$ BB_ENV_EXTRAWHITE="$BB_ENV_EXTRAWHITE PYOCD_FLASH_IDS" \ $ BB_ENV_EXTRAWHITE="$BB_ENV_EXTRAWHITE PYOCD_FLASH_IDS" \
PYOCD_FLASH_IDS="9009022103BB3A2DFE6555DC" bitbake zephyr-blueprint-smarthome-switch -c flash_usb PYOCD_FLASH_IDS="9009022103BB3A2DFE6555DC" bitbake zephyr-blueprint-smarthome-switch -c flash_usb
Prepare IoT controller (Avenger96/Linux flavour) Prepare IoT controller (Avenger96/Linux flavour)
************************************************ ************************************************
...@@ -264,9 +264,7 @@ Build ...@@ -264,9 +264,7 @@ Build
.. code-block:: bash .. code-block:: bash
user@pc:~/ohos$ TEMPLATECONF=../sources/meta-ohos/flavours/linux . ./sources/poky/oe-init-build-env build-ohos-linux-stm32mp1-av96 $ TEMPLATECONF=../oniro/flavours/linux . ./oe-core/oe-init-build-env build-oniro-linux-stm32mp1-av96
user@pc:~/ohos/build-ohos-linux-stm32mp1-av96
#. #.
Edit ``conf/local.conf``, and uncomment the following line: Edit ``conf/local.conf``, and uncomment the following line:
...@@ -291,7 +289,7 @@ Build ...@@ -291,7 +289,7 @@ Build
.. code-block:: bash .. code-block:: bash
user@pc:~/ohos/build-ohos-linux-stm32mp1-av96$ DISTRO=allscenarios-linux-blueprint-dashboard \ $ DISTRO=allscenarios-linux-blueprint-dashboard \
BB_ENV_EXTRAWHITE="$BB_ENV_EXTRAWHITE SMART_HOME_SENSORS_MAC SMART_HOME_SWITCH_MAC" \ BB_ENV_EXTRAWHITE="$BB_ENV_EXTRAWHITE SMART_HOME_SENSORS_MAC SMART_HOME_SWITCH_MAC" \
SMART_HOME_SENSORS_MAC="C0:BA:DD:06:F0:0D" \ SMART_HOME_SENSORS_MAC="C0:BA:DD:06:F0:0D" \
SMART_HOME_SWITCH_MAC="C0:BA:DD:06:F0:0E" \ SMART_HOME_SWITCH_MAC="C0:BA:DD:06:F0:0E" \
...@@ -313,9 +311,9 @@ Flash ...@@ -313,9 +311,9 @@ Flash
.. code-block:: bash .. code-block:: bash
user@pc:~/ohos/build-ohos-linux-stm32mp1-av96$ cd tmp/deploy/images/stm32mp1-av96 $ cd tmp/deploy/images/stm32mp1-av96
user@pc:~/ohos/build-ohos-linux-stm32mp1-av96/tmp/deploy/images/stm32mp1-av96$ ./scripts/create_sdcard_from_flashlayout.sh \ $ ./scripts/create_sdcard_from_flashlayout.sh \
flashlayout_blueprint-dashboard-gateway-image/extensible/FlashLayout_sdcard_stm32mp157a-av96-extensible.tsv flashlayout_blueprint-dashboard-gateway-image/extensible/FlashLayout_sdcard_stm32mp157a-av96-extensible.tsv
#. #.
......
docs/blueprints/transparent-gateway.rst
+ 4
− 4
View file @ bd3bf7a5
...@@ -48,7 +48,7 @@ In our default WiFi access point configuration, we create an AP on channel 6 in ...@@ -48,7 +48,7 @@ In our default WiFi access point configuration, we create an AP on channel 6 in
SSID: "|main_project_name| WiFi" SSID: "|main_project_name| WiFi"
Passphrase: "12345678". Passphrase: "12345678".
For more details, the used `hostapd configuration file <https://git.ostc-eu.org/OSTC/OHOS/meta-ohos/-/blob/develop/meta-ohos-blueprints/recipes-connectivity/hostapd/files/hostapd.conf>`_ is the best reference. For more details, the used `hostapd configuration file <https://git.ostc-eu.org/distro/oniro/-/blob/dunfell/meta-oniro-blueprints/recipes-connectivity/hostapd/files/hostapd.conf>`_ is the best reference.
OpenThread Border Router Configuration OpenThread Border Router Configuration
************************************** **************************************
...@@ -58,7 +58,7 @@ In our default OpenThread Border Router configuration, we create an OpenThread m ...@@ -58,7 +58,7 @@ In our default OpenThread Border Router configuration, we create an OpenThread m
Networkname "ASOS Thread" Networkname "ASOS Thread"
OpenThread masterkey: 00112233445566778899aabbccddeeff OpenThread masterkey: 00112233445566778899aabbccddeeff
For more details, the used `OpenThread configuration script <https://git.ostc-eu.org/OSTC/OHOS/meta-ohos/-/blob/develop/meta-ohos-blueprints/recipes-connectivity/openthread/ot-br-posix/otbr-configuration>`_ is the best reference. For more details, the used `OpenThread configuration script <https://git.ostc-eu.org/distro/oniro/-/blob/dunfell/meta-oniro-blueprints/recipes-connectivity/openthread/ot-br-posix/otbr-configuration>`_ is the best reference.
Get sources Get sources
*********** ***********
...@@ -68,13 +68,13 @@ Get sources ...@@ -68,13 +68,13 @@ Get sources
.. code-block:: bash .. code-block:: bash
user@pc:~/ohos$ repo sync -d $ repo sync -d
#. To build the image for this blueprint, you need to set the corresponding distro in the conf/local.conf file or on the command-line as seen below. #. To build the image for this blueprint, you need to set the corresponding distro in the conf/local.conf file or on the command-line as seen below.
.. code-block:: bash .. code-block:: bash
user@pc:~/ohos$ DISTRO="allscenarios-linux-blueprint-gateway" MACHINE=raspberrypi4-64 bitbake blueprint-gateway-image $ DISTRO="allscenarios-linux-blueprint-gateway" MACHINE=raspberrypi4-64 bitbake blueprint-gateway-image
Resources Resources
********* *********
......
docs/conf.py
+ 1
− 1
View file @ bd3bf7a5
...@@ -21,7 +21,7 @@ ...@@ -21,7 +21,7 @@
# -- Project information ----------------------------------------------------- # -- Project information -----------------------------------------------------
project = 'All Scenarios OS Build System and meta-ohos' project = 'Oniro Project Build System'
copyright = '2021' copyright = '2021'
author = 'OSTC' author = 'OSTC'
......
docs/hardware-support/adding-hardware-support.rst
+ 8
− 11
View file @ bd3bf7a5
...@@ -8,8 +8,8 @@ Adding New Hardware Support in |main_project_name| ...@@ -8,8 +8,8 @@ Adding New Hardware Support in |main_project_name|
################################################## ##################################################
This section details the addition of new hardware to the supported set in This section details the addition of new hardware to the supported set in
|main_project_name|. It is intended as a checklist for adding new boards to OHOS build |main_project_name|. It is intended as a checklist for adding new boards to
system. |main_project_name| build system.
Before starting get familiar with |main_project_name| Contribution Process. Before starting get familiar with |main_project_name| Contribution Process.
...@@ -33,7 +33,7 @@ maintained support** in targeted kernels. ...@@ -33,7 +33,7 @@ maintained support** in targeted kernels.
Add Required meta-layers Add Required meta-layers
************************ ************************
OHOS flavours configuration templates (stored in `OHOS/meta-ohos/flavours <https://git.ostc-eu.org/OSTC/OHOS/meta-ohos/-/tree/develop/flavours>`_ Oniro flavours configuration templates (stored in `distro/oniro/flavours <https://git.ostc-eu.org/distro/oniro/-/tree/dunfell/flavours>`_
directory) consist of the following files: directory) consist of the following files:
.. list-table:: Configuration Files .. list-table:: Configuration Files
...@@ -53,9 +53,8 @@ directory) consist of the following files: ...@@ -53,9 +53,8 @@ directory) consist of the following files:
into appropriate build directory structure (see :ref:`Setting up a repo workspace <RepoWorkspace>`). 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: To include a new layer, it has to be added in two places:
- `OHOS/manifest <https://git.ostc-eu.org/OSTC/OHOS/manifest>`_ - The manifest file part of the `oniro repository <https://git.ostc-eu.org/distro/oniro/-/tree/dunfell/manifests>`_
- `OHOS/meta-ohos flavours <https://git.ostc-eu.org/OSTC/OHOS/meta-ohos/-/tree/develop/flavours>`_ - The flavours ``bblayers.conf.sample`` file part of the `oniro repository <https://git.ostc-eu.org/distro/oniro/-/tree/dunfell/flavours>`_
as part of the respective flavour ``bblayers.conf.sample``
Test Image Backward Compatibility Of Newly Added Layers Test Image Backward Compatibility Of Newly Added Layers
******************************************************* *******************************************************
...@@ -78,9 +77,7 @@ The same machine needs to also be advertised in two places: ...@@ -78,9 +77,7 @@ The same machine needs to also be advertised in two places:
Create Merge Requests Create Merge Requests
********************* *********************
Create Merge Requests to ***develop*** branch according to the Contributing Process for repositories: Create the Merge Request against the ***dunfell*** branch according to the
Contributing Process for repositories:
- `OHOS/meta-ohos <https://git.ostc-eu.org/OSTC/OHOS/meta-ohos>`_ - `distro/oniro <https://git.ostc-eu.org/distro/oniro>`_
- `OHOS/manifest <https://git.ostc-eu.org/OSTC/OHOS/manifest>`_
After meta-ohos MR is merged, update ``meta-ohos`` revision in manifest MR.
docs/hardware-support/boards/96b-Avenger.rst
+ 2
− 2
View file @ bd3bf7a5
...@@ -47,7 +47,7 @@ Linux image ...@@ -47,7 +47,7 @@ Linux image
.. code-block:: console .. code-block:: console
$ TEMPLATECONF=../sources/meta-ohos/flavours/linux . ./sources/poky/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* 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 *allscenarios-image-base*
...@@ -67,7 +67,7 @@ Zephyr image ...@@ -67,7 +67,7 @@ Zephyr image
.. code-block:: console .. code-block:: console
$ TEMPLATECONF=../sources/meta-ohos/flavours/zephyr . ./sources/poky/oe-init-build-env build-ohos-zephyr $ TEMPLATECONF=../oniro/flavours/zephyr . ./oe-core/oe-init-build-env build-oniro-zephyr
2. You will find yourself in the newly created build directory. Call *bitbake* 2. You will find yourself in the newly created build directory. Call *bitbake*
to build the image. The image name is the name of the Zephyr application. to build the image. The image name is the name of the Zephyr application.
......
docs/hardware-support/boards/arduino-nano-33-ble.rst
+ 3
− 3
View file @ bd3bf7a5
...@@ -52,7 +52,7 @@ Building an application ...@@ -52,7 +52,7 @@ Building an application
.. code-block:: console .. code-block:: console
$ TEMPLATECONF=../sources/meta-ohos/flavours/zephyr . ./sources/poky/oe-init-build-env build-ohos-zephyr $ TEMPLATECONF=../oniro/flavours/zephyr . ./oe-core/oe-init-build-env build-oniro-zephyr
2. You will find yourself in the newly created build directory. Call *bitbake* 2. You will find yourself in the newly created build directory. Call *bitbake*
to build the image. The supported image name is *zephyr-philosophers*. to build the image. The supported image name is *zephyr-philosophers*.
...@@ -72,7 +72,7 @@ sample application, *blinky*. In order to do so issue the following: ...@@ -72,7 +72,7 @@ sample application, *blinky*. In order to do so issue the following:
$ MACHINE=arduino-nano-33-ble bitbake zephyr-blinky $ MACHINE=arduino-nano-33-ble bitbake zephyr-blinky
3. After the build completes, the ``zephyr-philosophers.bin`` and the ``zephyr-blinky.bin`` 3. After the build completes, the ``zephyr-philosophers.bin`` and the ``zephyr-blinky.bin``
file can be found in ``build-ohos-zephyr/tmp-newlib/deploy/images/arduino-nano-33-ble/``. file can be found in ``build-oniro-zephyr/tmp-newlib/deploy/images/arduino-nano-33-ble/``.
Flashing an application Flashing an application
======================= =======================
...@@ -153,4 +153,4 @@ How to flash ...@@ -153,4 +153,4 @@ How to flash
Philosopher 3 [P: 0] HOLDING ONE FORK Philosopher 3 [P: 0] HOLDING ONE FORK
Philosopher 2 [P: 1] DROPPED ONE FORK Philosopher 2 [P: 1] DROPPED ONE FORK
Philosopher 2 [P: 1] THINKING [ 725 ms ] Philosopher 2 [P: 1] THINKING [ 725 ms ]
Philosopher 1 [P: 2] EATING [ 225 ms ] Philosopher 1 [P: 2] EATING [ 225 ms ]
\ No newline at end of file
docs/hardware-support/boards/nRF52840-DK.rst
+ 2
− 2
View file @ bd3bf7a5
...@@ -39,7 +39,7 @@ Building an application ...@@ -39,7 +39,7 @@ Building an application
.. code-block:: console .. code-block:: console
$ TEMPLATECONF=../sources/meta-ohos/flavours/zephyr . ./sources/poky/oe-init-build-env build-ohos-zephyr $ TEMPLATECONF=../oniro/flavours/zephyr . ./oe-core/oe-init-build-env build-oniro-zephyr
2. You will find yourself in the newly created build directory. Call ``bitbake`` 2. You will find yourself in the newly created build directory. Call ``bitbake``
to build the image. Example below shows how to build ``zephyr-philosophers``. to build the image. Example below shows how to build ``zephyr-philosophers``.
...@@ -52,7 +52,7 @@ Building an application ...@@ -52,7 +52,7 @@ Building an application
under the build directory, or via the command line. under the build directory, or via the command line.
3. After the build completes, the image file can be found in 3. After the build completes, the image file can be found in
``build-ohos-zephyr/tmp-newlib/deploy/images/nrf52840dk-nrf52840/``. ``build-oniro-zephyr/tmp-newlib/deploy/images/nrf52840dk-nrf52840/``.
Flashing an application Flashing an application
======================= =======================
......
docs/hardware-support/boards/raspberrypi4.rst
+ 7
− 7
View file @ bd3bf7a5
...@@ -69,8 +69,8 @@ Linux image ...@@ -69,8 +69,8 @@ Linux image
.. code-block:: console .. code-block:: console
$ TEMPLATECONF=../sources/meta-ohos/flavours/linux . \ $ TEMPLATECONF=../oniro/flavours/linux . \
./sources/poky/oe-init-build-env build-ohos-linux-raspberrypi4-64 ./oe-core/oe-init-build-env build-oniro-linux-raspberrypi4-64
2. You will find yourself in the newly created build directory. Call *bitbake* 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 *allscenarios-image-base*
...@@ -82,7 +82,7 @@ Linux image ...@@ -82,7 +82,7 @@ Linux image
3. After the build completes, the bootloader, kernel, and rootfs image files 3. After the build completes, the bootloader, kernel, and rootfs image files
can be found in can be found in
``build-ohos-linux-raspberrypi4-64/tmp/deploy/images/$MACHINE/``. ``build-oniro-linux-raspberrypi4-64/tmp/deploy/images/$MACHINE/``.
The key file which is needed to flash into the SD card is The key file which is needed to flash into the SD card is
``allscenarios-image-base-raspberrypi4-64.wic.bz2``. ``allscenarios-image-base-raspberrypi4-64.wic.bz2``.
...@@ -143,8 +143,8 @@ For any fault in the hardware device, see :ref:`How to handle faulty hardware de ...@@ -143,8 +143,8 @@ For any fault in the hardware device, see :ref:`How to handle faulty hardware de
Audio Audio
===== =====
To enable the audio over 3.5mm jack, add the following line in To enable the audio over 3.5mm jack, add the following line in your build's
``./sources/meta-ohos/flavours/linux/local.conf.sample`` ``local.conf``:
.. code-block:: console .. code-block:: console
...@@ -172,8 +172,8 @@ audio. ...@@ -172,8 +172,8 @@ audio.
I2C I2C
=== ===
I2C is disabled by default. To enable I2C, edit the I2C is disabled by default. To enable I2C, edit the ``local.conf`` build's
``./sources/meta-ohos/flavours/linux/local.conf.sample`` file with below line: configuration adding:
.. code-block:: console .. code-block:: console
......
docs/hardware-support/boards/seco-imx8mm-c61.rst
+ 1
− 1
View file @ bd3bf7a5
...@@ -41,7 +41,7 @@ Linux image ...@@ -41,7 +41,7 @@ Linux image
.. code-block:: console .. code-block:: console
$ TEMPLATECONF=../sources/meta-ohos/flavours/linux . ./sources/poky/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. 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 ``allscenarios-image-base``.
......
docs/hardware-support/boards/seco-intel-b68.rst
+ 3
− 3
View file @ bd3bf7a5
...@@ -30,8 +30,8 @@ For more detailed specifications of SBC-B68-eNUC SECO board, see `SBC-B68-eNUC S ...@@ -30,8 +30,8 @@ For more detailed specifications of SBC-B68-eNUC SECO board, see `SBC-B68-eNUC S
Working with the board Working with the board
********************** **********************
Building OHOS image Building Oniro image
=================== ====================
To clone the source code, perform the procedure in: :ref:`Setting up a repo workspace <RepoWorkspace>`. To clone the source code, perform the procedure in: :ref:`Setting up a repo workspace <RepoWorkspace>`.
...@@ -42,7 +42,7 @@ Linux image ...@@ -42,7 +42,7 @@ Linux image
.. code-block:: console .. code-block:: console
$ TEMPLATECONF=../sources/meta-ohos/flavours/linux . ./sources/poky/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* 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 *allscenarios-image-base* run the following command:
......
docs/hardware-support/virtual-boards/qemux86-64.rst
+ 1
− 1
View file @ bd3bf7a5
...@@ -34,7 +34,7 @@ Build steps ...@@ -34,7 +34,7 @@ Build steps
.. code-block:: console .. code-block:: console
$ TEMPLATECONF=../sources/meta-ohos/flavours/linux . ./sources/poky/oe-init-build-env build-ohos-linux $ TEMPLATECONF=../oniro/flavours/linux . ./oe-core/oe-init-build-env build-ohos-linux
2. You will find yourself in the newly created build directory. Call *bitbake* 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 *allscenarios-image-base*
......
docs/repo-workspace.rst
+ 23
− 24
View file @ bd3bf7a5
...@@ -81,13 +81,13 @@ repositories. If you're on OpenMandriva, simply ``dnf install repo``. ...@@ -81,13 +81,13 @@ repositories. If you're on OpenMandriva, simply ``dnf install repo``.
The Manifests The Manifests
************* *************
The `manifest repository <https://git.ostc-eu.org/OSTC/OHOS/manifest>`_ The ``repo manifest`` files are part of the main `oniro repository <https://git.ostc-eu.org/distro/oniro>`_
provides the manifest for configuring a workspace. The project provides and are to be used for configuring a workspace. The project provides a single
a single ``default.xml`` manifest file in each of the active branches. ``default.xml`` manifest file in each of the active branches.
Depending on the specific branch of the manifest repository, that manifest may Depending on the specific branch of the above-mentioned repository, that
either allow some projects to follow changes by selecting git branches or pin manifest may either allow some projects to follow changes by selecting git
all projects to a specific git commit revision. branches or pin all projects to a specific git commit revision.
Setting up the Workspace Setting up the Workspace
************************ ************************
...@@ -97,13 +97,10 @@ This will bring in all the needed sources for building |main_project_name|: ...@@ -97,13 +97,10 @@ This will bring in all the needed sources for building |main_project_name|:
.. code-block:: console .. code-block:: console
$ mkdir ohos; cd ohos $ mkdir oniroproject; cd oniroproject
$ repo init -u https://git.ostc-eu.org/OSTC/OHOS/manifest.git -b stable $ repo init -u https://git.ostc-eu.org/distro/oniro
$ repo sync --no-clone-bundle $ repo sync --no-clone-bundle
You can checkout latest development source code by using *develop* branch
instead of *stable* as part of the above repo init command.
Workspace structure Workspace structure
******************* *******************
...@@ -111,18 +108,20 @@ A fully set workspace, will provide a structure similar to: ...@@ -111,18 +108,20 @@ A fully set workspace, will provide a structure similar to:
.. code-block:: none .. code-block:: none
./ohos/ ./oniroproject/
└── sources ├── bitbake
├── meta-freertos ├── docs
├── meta-ohos ├── ip-policy
├── meta-openembedded ├── meta-openembedded
├── meta-zephyr ├── meta-raspberrypi
├── <various yocto layers> ├── meta-zephyr
└── poky ├── <various bitbake layers>
├── oe-core
The *sources* directory will include ``poky`` and all the build system layers ├── oniro
that are part of the build process. Any new layers will be included under this └── README.md
directory.
All the bitbake layers are included at the root of the workspace. See for
example ``meta-openembedded`` above.
It is recommended to use the root of the workspace for the build directories It is recommended to use the root of the workspace for the build directories
using ``build`` as directory name prefix. using ``build-`` as directory name prefix.
docs/yocto-build-system/ohos-build-arch.rst
+ 2
− 2
View file @ bd3bf7a5
...@@ -7,7 +7,7 @@ ...@@ -7,7 +7,7 @@
|main_project_name| Build Architecture |main_project_name| Build Architecture
###################################### ######################################
``meta-ohos`` architecture is documented using `c4 model <https://c4model.com/>`_. ``Oniro Project`` architecture is documented using `c4 model <https://c4model.com/>`_.
.. contents:: .. contents::
:depth: 2 :depth: 2
...@@ -18,7 +18,7 @@ Overview ...@@ -18,7 +18,7 @@ Overview
|main_project_name| 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. ranging from RTOSes to Linux.
``meta-ohos`` is an *umbrella* of meta layers containing build's meta-data ``oniro`` is an *umbrella* of meta layers containing build's meta-data
required for compiling |main_project_name| images. The architecture supports plugging required for compiling |main_project_name| images. The architecture supports plugging
various kernels. various kernels.
......
docs/yocto-build-system/yocto-project.rst
+ 9
− 9
View file @ bd3bf7a5
...@@ -34,24 +34,24 @@ for more information. ...@@ -34,24 +34,24 @@ for more information.
|main_project_name| Build Layers |main_project_name| Build Layers
-------------------------------- --------------------------------
|main_project_name| bases its build setup on Poky, the Yocto Project open source |main_project_name| bases its build setup on OE-core and bitbake. The main hub
reference embedded distribution. The main hub of layers, is `meta-ohos <https://git.ostc-eu.org/OSTC/meta-ohos/>`_, of layers, is `oniro <https://git.ostc-eu.org/distro/oniro/>`_, a
a collection of layers with different scopes for defining the project's collection of layers with different scopes for defining the project's
requirements and capabilities. requirements and capabilities.
For example, ``meta-ohos-core`` provides build recipes for defining the core For example, ``meta-oniro-core`` provides build recipes for defining the core
policies of the build infrastructure (`distribution` configuration, images, policies of the build infrastructure (`distribution` configuration, images,
core packages customization, etc.). core packages customization, etc.).
Another example is ``meta-ohos-staging``, a layer that provides temporary fixes Another example is ``meta-oniro-staging``, a layer that provides temporary fixes
and support for changes that are aimed upstream but have this place until and support for changes that are aimed upstream but have this place until
upstream catches up. upstream catches up.
For more details of each provided layer of ``meta-ohos``, see the relevant For more details of each provided layer of ``oniro``, see the relevant
``README.md`` file at the root of the layer, ``README.md`` file at the root of the layer.
Besides the ``meta-ohos`` collection of layers, the project is also the home Besides the ``oniro`` collection of layers, the project is also the home
to a set of other build system layers. Explore them all in our project `GitLab <https://git.ostc-eu.org/OSTC/OHOS>`_ to a set of other build system layers. Explore them all in our project `GitLab <https://git.ostc-eu.org/distro>`_
instance. instance.
Additional Documentation Additional Documentation
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment

Copyright © Eclipse Foundation, Inc. All Rights Reserved.     Privacy Policy | Terms of Use | Copyright Agent