From 9e26b1afda8674da878ce2aa6f4b3cb671a836f3 Mon Sep 17 00:00:00 2001 From: Zygmunt Krynicki <zygmunt.krynicki@huawei.com> Date: Tue, 20 Apr 2021 14:05:06 +0000 Subject: [PATCH] docs: rename openharmony to allscenarios External repositories for various distributions are left unchanged. Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@huawei.com> --- ...build.rst => allscenarios-quick-build.rst} | 8 +++--- docs/blueprints/smart-panel.rst | 6 ++--- docs/build-flavours/linux-flavour.rst | 12 ++++----- docs/build-flavours/zephyr-flavour.rst | 2 +- docs/hardware-support/boards/96b-Avenger.rst | 26 +++++++++---------- .../boards/seco-imx8mm-c61.rst | 10 +++---- .../boards/seco-intel-b68.rst | 10 +++---- .../virtual-boards/qemuarm.rst | 8 +++--- .../virtual-boards/qemuarm64.rst | 8 +++--- .../virtual-boards/qemux86-64.rst | 8 +++--- .../virtual-boards/qemux86.rst | 8 +++--- docs/index.rst | 2 +- 12 files changed, 54 insertions(+), 54 deletions(-) rename docs/{openharmony-quick-build.rst => allscenarios-quick-build.rst} (92%) diff --git a/docs/openharmony-quick-build.rst b/docs/allscenarios-quick-build.rst similarity index 92% rename from docs/openharmony-quick-build.rst rename to docs/allscenarios-quick-build.rst index 678ef713..d4f64a1b 100644 --- a/docs/openharmony-quick-build.rst +++ b/docs/allscenarios-quick-build.rst @@ -53,10 +53,10 @@ Initialize a repo workspace and clone all required repositories: $ repo init -u https://git.ostc-eu.org/OSTC/OHOS/manifest.git -b develop $ repo sync --no-clone-bundle -Build the openharmony-image-base image -************************************** +Build the allscenarios-image-base image +*************************************** -The following steps will build a ``openharmony-image-base``. The process will +The following steps will build a ``allscenarios-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 @@ -67,7 +67,7 @@ Initialize the build directory and run a build: .. code-block:: console $ TEMPLATECONF=../sources/meta-ohos/flavours/linux . ./sources/poky/oe-init-build-env build-ohos-linux - $ MACHINE=qemux86-64 bitbake openharmony-image-base + $ MACHINE=qemux86-64 bitbake allscenarios-image-base Booting a Qemu X86-64 target with a AllScenariOS image ****************************************************** diff --git a/docs/blueprints/smart-panel.rst b/docs/blueprints/smart-panel.rst index 14f447d7..5e3ae268 100644 --- a/docs/blueprints/smart-panel.rst +++ b/docs/blueprints/smart-panel.rst @@ -34,7 +34,7 @@ The Linux Gateway .. code-block:: console - $ MACHINE=stm32mp1-av96 DISTRO=openharmony-linux-blueprint-dashboard bitbake blueprint-dashboard-gateway-image + $ MACHINE=stm32mp1-av96 DISTRO=allscenarios-linux-blueprint-dashboard bitbake blueprint-dashboard-gateway-image IOT Endpoints @@ -55,7 +55,7 @@ IOT Endpoints .. code-block:: console - $ MACHINE=96b-nitrogen DISTRO=openharmony-zephyr bitbake zephyr-blueprint-smarthome-sensors -c flash_usb + $ MACHINE=96b-nitrogen DISTRO=allscenarios-zephyr bitbake zephyr-blueprint-smarthome-sensors -c flash_usb **For bulb/LED board:** @@ -63,5 +63,5 @@ IOT Endpoints .. code-block:: console - $ MACHINE=96b-nitrogen DISTRO=openharmony-zephyr bitbake zephyr-blueprint-smarthome-led -c flash_usb + $ MACHINE=96b-nitrogen DISTRO=allscenarios-zephyr bitbake zephyr-blueprint-smarthome-led -c flash_usb diff --git a/docs/build-flavours/linux-flavour.rst b/docs/build-flavours/linux-flavour.rst index 28a185e3..04de9eef 100644 --- a/docs/build-flavours/linux-flavour.rst +++ b/docs/build-flavours/linux-flavour.rst @@ -5,14 +5,14 @@ Linux Kernel Build Flavour ########################## -AllScenariOS Linux build flavour is based on *openharmony-linux* distribution (distro configuration). +AllScenariOS Linux build flavour is based on *allscenarios-linux* distribution (distro configuration). Supported images: -* openharmony-image-base -* openharmony-image-base-tests -* openharmony-image-extra -* openharmony-image-extra-tests +* allscenarios-image-base +* allscenarios-image-base-tests +* allscenarios-image-extra +* allscenarios-image-extra-tests Supported machines (default in **bold**): @@ -29,7 +29,7 @@ Build steps example: .. code-block:: console $ TEMPLATECONF=../sources/meta-ohos/flavours/linux . ./sources/poky/oe-init-build-env build-ohos-linux - $ bitbake openharmony-image-base + $ bitbake allscenarios-image-base You can test the image built for the qemux86-64 target by issuing: diff --git a/docs/build-flavours/zephyr-flavour.rst b/docs/build-flavours/zephyr-flavour.rst index fa95b289..5dca58ff 100644 --- a/docs/build-flavours/zephyr-flavour.rst +++ b/docs/build-flavours/zephyr-flavour.rst @@ -5,7 +5,7 @@ Zephyr Kernel Build Flavour ########################### -OpenHarmony Zephyr build flavour is based on *openharmony-zephyr* distribution (distro configuration). +OpenHarmony Zephyr build flavour is based on *allscenarios-zephyr* distribution (distro configuration). Supported images: diff --git a/docs/hardware-support/boards/96b-Avenger.rst b/docs/hardware-support/boards/96b-Avenger.rst index 876c65ca..b7716992 100644 --- a/docs/hardware-support/boards/96b-Avenger.rst +++ b/docs/hardware-support/boards/96b-Avenger.rst @@ -41,10 +41,10 @@ Supported images * - Image Name - Size - Description - * - openharmony-image-base + * - allscenarios-image-base - Approximate 100-200 MB - AllScenariOS image including the base OS software stack - * - openharmony-image-extra + * - allscenarios-image-extra - Approximate 100-200 MB - AllScenariOS Wayland image including the base OS software stack @@ -68,12 +68,12 @@ Linux image $ TEMPLATECONF=../sources/meta-ohos/flavours/linux . ./sources/poky/oe-init-build-env build-ohos-linux 2. You will find yourself in the newly created build directory. Call *bitbake* - to build the image. For example, if you are using *openharmony-image-base* + to build the image. For example, if you are using *allscenarios-image-base* run the following command: .. code-block:: console - $ MACHINE=stm32mp1-av96 bitbake openharmony-image-base + $ MACHINE=stm32mp1-av96 bitbake allscenarios-image-base To generate images for eMMC on SD card, refer to the :ref:`Flashing OHOS image <Flashing_ohos>`. @@ -128,12 +128,12 @@ For more information on Avenger96 boot options, see `Getting Started with the Av 1. After the image is built, run the following script with flash layout TSV file provided as an argument. From the build directory created during the environment source. For example, if you are using - openharmony-image-base run the following command: + allscenarios-image-base run the following command: .. code-block:: console $ cd tmp/deploy/images/stm32mp1-av96 - $ ./scripts/create_sdcard_from_flashlayout.sh ./flashlayout_openharmony-image-base/extensible/FlashLayout_sdcard_stm32mp157a-av96-extensible.tsv + $ ./scripts/create_sdcard_from_flashlayout.sh ./flashlayout_allscenarios-image-base/extensible/FlashLayout_sdcard_stm32mp157a-av96-extensible.tsv 2. The following output is displayed. For the image to be flashed to the card, copy and paste the commands to the terminal to flash the image onto the @@ -142,10 +142,10 @@ For more information on Avenger96 boot options, see `Getting Started with the Av :: [WARNING]: A previous raw image are present on this directory - [WARNING]: ./flashlayout_openharmony-image-base/extensible/../../FlashLayout_sdcard_stm32mp157a-av96-extensible.raw + [WARNING]: ./flashlayout_allscenarios-image-base/extensible/../../FlashLayout_sdcard_stm32mp157a-av96-extensible.raw [WARNING]: would you like to erase it: [Y/n] - Create Raw empty image: ./flashlayout_openharmony-image-base/extensible/../../FlashLayout_sdcard_stm32mp157a-av96-extensible.raw of 2368MB + Create Raw empty image: ./flashlayout_allscenarios-image-base/extensible/../../FlashLayout_sdcard_stm32mp157a-av96-extensible.raw of 2368MB Create partition table: [CREATED] part 1: fsbl1 [partition size 256.0 KiB] [CREATED] part 2: fsbl2 [partition size 256.0 KiB] @@ -154,7 +154,7 @@ For more information on Avenger96 boot options, see `Getting Started with the Av [CREATED] part 5: vendorfs [partition size 16.0 MiB] [CREATED] part 6: rootfs [partition size 2.2 GiB] - Partition table from ./flashlayout_openharmony-image-base/extensible/../../FlashLayout_sdcard_stm32mp157a-av96-extensible.raw + Partition table from ./flashlayout_allscenarios-image-base/extensible/../../FlashLayout_sdcard_stm32mp157a-av96-extensible.raw Populate raw image with image content: [ FILLED ] part 1: fsbl1, image: arm-trusted-firmware/tf-a-stm32mp157a-av96-trusted.stm32 @@ -162,19 +162,19 @@ For more information on Avenger96 boot options, see `Getting Started with the Av [ FILLED ] part 3: ssbl, image: bootloader/u-boot-stm32mp157a-av96-trusted.stm32 [ FILLED ] part 4: boot, image: st-image-bootfs-poky-stm32mp1-av96.ext4 [ FILLED ] part 5: vendorfs, image: st-image-vendorfs-poky-stm32mp1-av96.ext4 - [ FILLED ] part 6: rootfs, image: openharmony-image-base-stm32mp1-av96.ext4 + [ FILLED ] part 6: rootfs, image: allscenarios-image-base-stm32mp1-av96.ext4 ########################################################################### ########################################################################### - RAW IMAGE generated: ./flashlayout_openharmony-image-base/extensible/../../FlashLayout_sdcard_stm32mp157a-av96-extensible.raw + RAW IMAGE generated: ./flashlayout_allscenarios-image-base/extensible/../../FlashLayout_sdcard_stm32mp157a-av96-extensible.raw WARNING: before to use the command dd, please umount all the partitions associated to SDCARD. sudo umount `lsblk --list | grep mmcblk0 | grep part | gawk '{ print $7 }' | tr '\n' ' '` To put this raw image on sdcard: - sudo dd if=./flashlayout_openharmony-image-base/extensible/../../FlashLayout_sdcard_stm32mp157a-av96-extensible.raw of=/dev/mmcblk0 bs=8M conv=fdatasync status=progress + sudo dd if=./flashlayout_allscenarios-image-base/extensible/../../FlashLayout_sdcard_stm32mp157a-av96-extensible.raw of=/dev/mmcblk0 bs=8M conv=fdatasync status=progress (mmcblk0 can be replaced by: sdX if it's a device dedicated to receive the raw image @@ -196,7 +196,7 @@ STM32 Cube Programmer After you build the image, follow the instructions in `Avenger96 Image Programming <https://wiki.dh-electronics.com/index.php/Avenger96_Image_Programming>`_, pointing the program to the -*./tmp/deploy/images/stm32mp1-av96/flashlayout_openharmony-image-base/trusted/FlashLayout_emmc_stm32mp157a-av96-trusted.tsv* +*./tmp/deploy/images/stm32mp1-av96/flashlayout_allscenarios-image-base/trusted/FlashLayout_emmc_stm32mp157a-av96-trusted.tsv* flash layout file. .. _zephyr-image-1: diff --git a/docs/hardware-support/boards/seco-imx8mm-c61.rst b/docs/hardware-support/boards/seco-imx8mm-c61.rst index 9d342ef6..4b92be75 100644 --- a/docs/hardware-support/boards/seco-imx8mm-c61.rst +++ b/docs/hardware-support/boards/seco-imx8mm-c61.rst @@ -39,7 +39,7 @@ Supported image * - Image Name - Size - Description - * - openharmony-image-base + * - allscenarios-image-base - Approximate 100-200 MB - AllScenariOS image including the base OS software stack @@ -58,11 +58,11 @@ Linux image $ TEMPLATECONF=../sources/meta-ohos/flavours/linux . ./sources/poky/oe-init-build-env build-ohos-linux -2. You will find yourself in the newly created build directory. Call ``bitbake`` to build the image. The supported image is ``openharmony-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``. .. code-block:: console - $ MACHINE=seco-imx8mm-c61 bitbake openharmony-image-base + $ MACHINE=seco-imx8mm-c61 bitbake allscenarios-image-base To generate images for eMMC, refer to the following flashing procedure. @@ -96,13 +96,13 @@ To flash OHOS using USB to OTG adapter, perform the following steps: .. code-block:: console - $ gzip -d openharmony-image-base-seco-imx8mm-c61.wic.gz + $ gzip -d allscenarios-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 openharmony-image-base-seco-imx8mm-c61.wic + $ sudo uuu -b emmc_all imx-boot-seco-imx8mm-c61-emmc.bin-flash_evk allscenarios-image-base-seco-imx8mm-c61.wic #. Power ON SBC-C61 #. Remove **CN52 short circuit** diff --git a/docs/hardware-support/boards/seco-intel-b68.rst b/docs/hardware-support/boards/seco-intel-b68.rst index 6e4b87b8..5b88f9c3 100644 --- a/docs/hardware-support/boards/seco-intel-b68.rst +++ b/docs/hardware-support/boards/seco-intel-b68.rst @@ -38,10 +38,10 @@ Supported images * - Image Name - Size - Description - * - openharmony-image-base + * - allscenarios-image-base - Approximate 100-200 MB - AllScenariOS image including the base OS software stack - * - openharmony-image-extra + * - allscenarios-image-extra - Approximate 100-200 MB - AllScenariOS Wayland image including the base OS software stack @@ -60,11 +60,11 @@ Linux image $ TEMPLATECONF=../sources/meta-ohos/flavours/linux . ./sources/poky/oe-init-build-env build-ohos-linux -2. You will find yourself in the newly created build directory. Call *bitbake* to build the image. For example, if you are using *openharmony-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: .. code-block:: console - $ MACHINE=seco-intel-b68 bitbake openharmony-image-base + $ MACHINE=seco-intel-b68 bitbake allscenarios-image-base To generate images for SSD Disk, refer to the following flashing OHOS image section. @@ -96,7 +96,7 @@ To flash OHOS using USB storage, perform the following steps: .. code-block:: console - $ dd if=tmp/deploy/images/seco-intel-b68/openharmony-image-base-seco-intel-b68.wic of=/dev/sdbX + $ dd if=tmp/deploy/images/seco-intel-b68/allscenarios-image-base-seco-intel-b68.wic of=/dev/sdbX **Run OHOS** diff --git a/docs/hardware-support/virtual-boards/qemuarm.rst b/docs/hardware-support/virtual-boards/qemuarm.rst index b9c564be..abbfe145 100644 --- a/docs/hardware-support/virtual-boards/qemuarm.rst +++ b/docs/hardware-support/virtual-boards/qemuarm.rst @@ -30,9 +30,9 @@ Supported images * - Image Name - Description - * - openharmony-image-base + * - allscenarios-image-base - AllScenariOS image including the base OS software stack - * - openharmony-image-extra + * - allscenarios-image-extra - AllScenariOS Wayland image including the base OS software stack Build steps @@ -49,12 +49,12 @@ Build steps $ TEMPLATECONF=../sources/meta-ohos/flavours/linux . ./sources/poky/oe-init-build-env build-ohos-linux 2. You will find yourself in the newly created build directory. Call *bitbake* - to build the image. For example, if you are using *openharmony-image-base* + to build the image. For example, if you are using *allscenarios-image-base* run the following command: .. code-block:: console - $ MACHINE=qemuarm bitbake openharmony-image-base + $ MACHINE=qemuarm bitbake allscenarios-image-base Once the image is done, you can run the Qemu using the provided script wrapper: diff --git a/docs/hardware-support/virtual-boards/qemuarm64.rst b/docs/hardware-support/virtual-boards/qemuarm64.rst index 8ef0d0f4..29bdf71d 100644 --- a/docs/hardware-support/virtual-boards/qemuarm64.rst +++ b/docs/hardware-support/virtual-boards/qemuarm64.rst @@ -30,9 +30,9 @@ Supported images * - Image Name - Description - * - openharmony-image-base + * - allscenarios-image-base - AllScenariOS image including the base OS software stack - * - openharmony-image-extra + * - allscenarios-image-extra - AllScenariOS Wayland image including the base OS software stack Build steps @@ -49,12 +49,12 @@ Build steps $ TEMPLATECONF=../sources/meta-ohos/flavours/linux . ./sources/poky/oe-init-build-env build-ohos-linux 2. You will find yourself in the newly created build directory. Call *bitbake* - to build the image. For example, if you are using *openharmony-image-base* + to build the image. For example, if you are using *allscenarios-image-base* run the following command: .. code-block:: console - $ MACHINE=qemuarm64 bitbake openharmony-image-base + $ MACHINE=qemuarm64 bitbake allscenarios-image-base Once the image is done, you can run the Qemu using the provided script wrapper: diff --git a/docs/hardware-support/virtual-boards/qemux86-64.rst b/docs/hardware-support/virtual-boards/qemux86-64.rst index 9ce41d44..48b1fa9e 100644 --- a/docs/hardware-support/virtual-boards/qemux86-64.rst +++ b/docs/hardware-support/virtual-boards/qemux86-64.rst @@ -30,9 +30,9 @@ Supported images * - Image Name - Description - * - openharmony-image-base + * - allscenarios-image-base - AllScenariOS image including the base OS software stack - * - openharmony-image-extra + * - allscenarios-image-extra - AllScenariOS Wayland image including the base OS software stack Build steps @@ -49,12 +49,12 @@ Build steps $ TEMPLATECONF=../sources/meta-ohos/flavours/linux . ./sources/poky/oe-init-build-env build-ohos-linux 2. You will find yourself in the newly created build directory. Call *bitbake* - to build the image. For example, if you are using *openharmony-image-base* + to build the image. For example, if you are using *allscenarios-image-base* run the following command: .. code-block:: console - $ MACHINE=qemux86-64 bitbake openharmony-image-base + $ MACHINE=qemux86-64 bitbake allscenarios-image-base Once the image is done, you can run the Qemu using the provided script wrapper: diff --git a/docs/hardware-support/virtual-boards/qemux86.rst b/docs/hardware-support/virtual-boards/qemux86.rst index e4f9ee7c..e33c2229 100644 --- a/docs/hardware-support/virtual-boards/qemux86.rst +++ b/docs/hardware-support/virtual-boards/qemux86.rst @@ -30,9 +30,9 @@ Supported images * - Image Name - Description - * - openharmony-image-base + * - allscenarios-image-base - AllScenariOS image including the base OS software stack - * - openharmony-image-extra + * - allscenarios-image-extra - AllScenariOS Wayland image including the base OS software stack Build steps @@ -49,12 +49,12 @@ Build steps $ TEMPLATECONF=../sources/meta-ohos/flavours/linux . ./sources/poky/oe-init-build-env build-ohos-linux 2. You will find yourself in the newly created build directory. Call *bitbake* - to build the image. For example, if you are using *openharmony-image-base* + to build the image. For example, if you are using *allscenarios-image-base* run the following command: .. code-block:: console - $ MACHINE=qemux86 bitbake openharmony-image-base + $ MACHINE=qemux86 bitbake allscenarios-image-base Once the image is done, you can run the Qemu using the provided script wrapper: diff --git a/docs/index.rst b/docs/index.rst index f3a72a23..f9be8f42 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,7 +8,7 @@ Build system documentation .. toctree:: :maxdepth: 1 - openharmony-quick-build + allscenarios-quick-build yocto-build-system/index repo-workspace build-flavours/index -- GitLab