diff --git a/docs/README.md b/docs/README.md index 798c6330f6a8aaf867f7773fff969988c103b978..3ae1cab32ea5ea752bc70812d79c8f5b3ddc862c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,7 +4,7 @@ SPDX-FileCopyrightText: Huawei Inc. SPDX-License-Identifier: CC-BY-4.0 --> -# Documentation for Oniro build repository +# Documentation for Oniro Build Repository The documentation for `oniro` build repository is written as reST files and can be generated by using standard make targets: diff --git a/docs/fallback-devices-support.rst b/docs/fallback-devices-support.rst index 6975bb96591411f733982717eda1ad50611ffbd3..1c6ad69965bf9b6ac88a6fe98783b6fa57bdb780 100644 --- a/docs/fallback-devices-support.rst +++ b/docs/fallback-devices-support.rst @@ -4,7 +4,7 @@ .. _FallbackSupport: -How to handle faulty hardware device? +How to Handle Faulty Hardware Device? ##################################### In a situation where you have enabled a new board and one of the devices is diff --git a/docs/hardware-support/boards/96b-Avenger.rst b/docs/hardware-support/boards/96b-Avenger.rst index 5e178c7ee1a38a9cf2661606c957d11ce43874a0..f2183eab106c56a672295f3366fb8db7a208ca9b 100644 --- a/docs/hardware-support/boards/96b-Avenger.rst +++ b/docs/hardware-support/boards/96b-Avenger.rst @@ -28,7 +28,7 @@ Hardware For more details on Avenger96 board, see `Avenger96 product page <https://www.96boards.org/product/avenger96/>`_. -Working with the board +Working with the Board ********************** Building an Oniro image @@ -97,7 +97,7 @@ For Zephyr, there is no automation as for now. To have the ELF file in the files Linux image =========== -SD card +SD Card ------- The Avenger96 board supports multiple boot options which are selected by the @@ -198,10 +198,10 @@ Zephyr image There is no fully-featured console available in Linux yet, so typing commands to the Zephyr application is not possible. -Testing the board +Testing the Board ***************** -Serial port +Serial Port =========== To connect the USB converter serial port to the low-speed connector, see `Hardware User Manual <https://github.com/96boards/documentation/blob/master/consumer/avenger96/hardware-docs/files/avenger96-hardware-user-manual.pdf>`__. diff --git a/docs/hardware-support/boards/96b-nitrogen.rst b/docs/hardware-support/boards/96b-nitrogen.rst index f95a2eb5383354ff0c22f2606a3819c8e62dde92..6a7794eeb6885c8589076aa58ef014b7c1780a72 100644 --- a/docs/hardware-support/boards/96b-nitrogen.rst +++ b/docs/hardware-support/boards/96b-nitrogen.rst @@ -34,10 +34,10 @@ Hardware For more details on 96Boards Nitrogen, see `Nitrogen product page <https://www.96boards.org/product/nitrogen/>`_. -Working with the board +Working with the Board ********************** -Building an application +Building an Application ======================= |main_project_name| OS Zephyr flavour is based on Zephyr kernel. @@ -57,7 +57,7 @@ Building an application MACHINE variable can be set up in conf/local.conf file under build directory or via command line. -Flashing an application +Flashing an Application ======================= Installing pyOCD @@ -94,7 +94,7 @@ pyOCD is an open source Python package for programming and debugging Arm Cortex- When *ValueError: The device has no langid* error is displayed due to lack of permission, perform the instructions as suggested in https://github.com/pyocd/pyOCD/tree/master/udev. -How to flash +How to Flash ------------ * To flash the image, execute the command used to build the image with -c flash_usb appended. diff --git a/docs/hardware-support/boards/arduino-nano-33-ble.rst b/docs/hardware-support/boards/arduino-nano-33-ble.rst index ca3679f507178732ef5d8b04aad108b7b9028bc3..805d7df50a1b55fc34756d6c66b48b2dced7e188 100644 --- a/docs/hardware-support/boards/arduino-nano-33-ble.rst +++ b/docs/hardware-support/boards/arduino-nano-33-ble.rst @@ -39,10 +39,10 @@ Hardware * For product specification and Datasheet, see `Arduino page <https://content.arduino.cc/assets/Nano_BLE_MCU-nRF52840_PS_v1.1.pdf>`_. * For hardware schematics, see `Arduino <https://content.arduino.cc/assets/NANO33BLE_V2.0_sch.pdf>`_. -Working with the board +Working with the Board ********************** -Building an application +Building an Application ======================= |main_project_name| Zephyr flavour is based on the Zephyr kernel. @@ -74,7 +74,7 @@ sample application, *blinky*. In order to do so issue the following: 3. After the build completes, the ``zephyr-philosophers.bin`` and the ``zephyr-blinky.bin`` file can be found in ``build-oniro-zephyr/tmp-newlib/deploy/images/arduino-nano-33-ble/``. -Flashing an application +Flashing an Application ======================= To flash the image on Arduino Nano 33 BLE device, ensure it enters the bootloader state: diff --git a/docs/hardware-support/boards/nRF52840-DK.rst b/docs/hardware-support/boards/nRF52840-DK.rst index 3ae268f0a559aba8f3a79876a5db0f2ddeb59471..25a622fa7edb8aed6aebbf3c2cfa86f111a3fbb1 100644 --- a/docs/hardware-support/boards/nRF52840-DK.rst +++ b/docs/hardware-support/boards/nRF52840-DK.rst @@ -26,10 +26,10 @@ Hardware * For detailed specifications, see nRF52840 DK product page on the `nRF52840 DK website <https://www.nordicsemi.com/Software-and-Tools/Development-Kits/nRF52840-DK>`_. * For hardware schematics, see `nRF52840 Development Kit <https://www.nordicsemi.com/Software-and-tools/Development-Kits/nRF52840-DK/Download#infotabs>`_. -Working with the board +Working with the Board ********************** -Building an application +Building an Application ======================= |main_project_name| Zephyr flavour is based on Zephyr kernel. @@ -54,7 +54,7 @@ Building an application 3. After the build completes, the image file can be found in ``build-oniro-zephyr/tmp-newlib/deploy/images/nrf52840dk-nrf52840/``. -Flashing an application +Flashing an Application ======================= pyOCD is a required host tool used by the flashing mechanism described below: diff --git a/docs/hardware-support/boards/raspberrypi4.rst b/docs/hardware-support/boards/raspberrypi4.rst index 8451e38fb0bb1c79f77aab2d8a7a3d9879c501db..3027f50c63a537ea45fc2e087252654f7537f1d3 100644 --- a/docs/hardware-support/boards/raspberrypi4.rst +++ b/docs/hardware-support/boards/raspberrypi4.rst @@ -86,10 +86,10 @@ Linux image The key file which is needed to flash into the SD card is ``oniro-image-base-raspberrypi4-64.wic.bz2``. -Flashing |main_project_name| Linux Image +Flashing |main_project_name| Linux image **************************************** -SD card +SD Card ======= The Raspberry Pi 4 board support multiple boot options. The below section @@ -108,7 +108,7 @@ describes booting the board with an SD card option. 2. Put the card to the board and turn it on. -Testing the board +Testing the Board ***************** HDMI diff --git a/docs/hardware-support/boards/seco-imx8mm-c61.rst b/docs/hardware-support/boards/seco-imx8mm-c61.rst index bd1ec9a4c9fa33872576c489e737d6fd8a614b40..cfbb8960b4abfa1cc43973fbf8d83310ad4772b7 100644 --- a/docs/hardware-support/boards/seco-imx8mm-c61.rst +++ b/docs/hardware-support/boards/seco-imx8mm-c61.rst @@ -26,7 +26,7 @@ Hardware For more detailed specifications of SBC-C61 SECO board, see `SBC-C61 Specification <https://www.seco.com/en/products/sbc-c61>`__. -Working with the board +Working with the Board ********************** Building an Oniro image @@ -94,7 +94,7 @@ following steps: #. Remove **CN52 short circuit** #. Press the reset button -Testing the board +Testing the Board ***************** Ethernet diff --git a/docs/hardware-support/boards/seco-intel-b68.rst b/docs/hardware-support/boards/seco-intel-b68.rst index dc853b3a26d267e200991ee23466a076c4b02f05..53741c13e829fd2abe30b7e9043ddb344ad31329 100644 --- a/docs/hardware-support/boards/seco-intel-b68.rst +++ b/docs/hardware-support/boards/seco-intel-b68.rst @@ -27,7 +27,7 @@ Hardware For more detailed specifications of SBC-B68-eNUC SECO board, see `SBC-B68-eNUC Specification <https://www.seco.com/en/products/sbc-b68-enuc>`__. -Working with the board +Working with the Board ********************** Building an Oniro image @@ -103,7 +103,7 @@ steps: #. Select the bootable USB device under **Boot Override** and press Enter. -Testing the board +Testing the Board ***************** Ethernet @@ -132,7 +132,7 @@ eMMC 954240 cylinders, 4 heads, 16 sectors/track Units: sectors of 1 * 512 = 512 bytes -PCI buses +PCI Buses ========= :: diff --git a/docs/hardware-support/index.rst b/docs/hardware-support/index.rst index b89afad0bd5c48be93f10605fa287fdabc783377..781e2f31acb28574df4034bb5ab52f6e8f63b14e 100644 --- a/docs/hardware-support/index.rst +++ b/docs/hardware-support/index.rst @@ -6,7 +6,7 @@ .. _HardwareSupport: -Hardware support in |main_project_name| +Hardware Support in |main_project_name| ####################################### This section details the hardware (including virtualized) supported as part of diff --git a/docs/hardware-support/virtual-boards/qemux86-64.rst b/docs/hardware-support/virtual-boards/qemux86-64.rst index bb4e3452067c90ff9eea8e6e8b4feea22ce65d15..2797263ebfcbffcfed8e5ef976ca129b2448b4c4 100644 --- a/docs/hardware-support/virtual-boards/qemux86-64.rst +++ b/docs/hardware-support/virtual-boards/qemux86-64.rst @@ -23,7 +23,7 @@ To clone the source code, perform the procedure in: :ref:`Setting up a repo work Building a Linux image ====================== -Build steps +Build Steps ----------- 1. Source the environment with proper template settings, flavour being *linux* diff --git a/docs/hardware-support/virtual-boards/qemux86.rst b/docs/hardware-support/virtual-boards/qemux86.rst index 5c7e45a89fce9b3f2f2ec33a1459f6cd1bdc46d7..c7e72b056e37b8d1e89f86f56b980a29ff14756b 100644 --- a/docs/hardware-support/virtual-boards/qemux86.rst +++ b/docs/hardware-support/virtual-boards/qemux86.rst @@ -23,7 +23,7 @@ To clone the source code, perform the procedure in: :ref:`Setting up a repo work Building a Linux image ====================== -Build steps +Build Steps ----------- 1. Source the environment with proper template settings, flavour being *linux* diff --git a/docs/oniro-build/visual-customizations.rst b/docs/oniro-build/visual-customizations.rst index 729893b671c6aa08d95951dc09e50f850946d701..7fde608223af2374f0f75fe478c81b2da30cdb3d 100644 --- a/docs/oniro-build/visual-customizations.rst +++ b/docs/oniro-build/visual-customizations.rst @@ -8,7 +8,7 @@ Build System Visual Customizations .. contents:: :depth: 2 -Weston dynamic configuration +Weston Dynamic Configuration **************************** The build exposes mechanism to tweak weston configuration through build @@ -28,7 +28,7 @@ Additional variable to be used in conjunction with ``WESTON_DYNAMIC_INI``: * ``WESTON_INI_BACKGROUND_COLOR`` - sets shell.background-color accordingly * ``WESTON_INI_BACKGROUND_TYPE`` - sets shell.background-type accordingly -Epiphany support for Application mode +Epiphany Support for Application Mode ************************************* Epiphany is one of the browsers supported by the build meta-data. It provides a diff --git a/docs/oniro-quick-build.rst b/docs/oniro-quick-build.rst index 21f346f4781a3df96910e972f65168e1ba9a546e..f8d95069d593c1ccb1a5686be35762cc4bea7940 100644 --- a/docs/oniro-quick-build.rst +++ b/docs/oniro-quick-build.rst @@ -35,7 +35,7 @@ Install all the required host packages. Here is an example for **Ubuntu**: See `official Yocto documentation <https://www.yoctoproject.org/docs/latest/ref-manual/ref-manual.html#required-packages-for-the-build-host>`_ for host package requirements on all supported Linux distributions. -Clone build system repositories +Clone Build System Repositories ******************************* Install Google git repo tool. For example, on **Ubuntu 20.04**, you can do this @@ -77,7 +77,7 @@ Initialize the build directory and run a build: $ TEMPLATECONF=../oniro/flavours/linux . ./oe-core/oe-init-build-env build-oniro-linux $ MACHINE=qemux86-64 bitbake oniro-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 ************************************************************* Once the image is built, you can run a Qemu X86-64 instance using the provided script wrapper as follows: diff --git a/docs/repo-workspace.rst b/docs/repo-workspace.rst index 3b369b28f1bb8a037739e18d3ade2f615dc30d23..7a12c26a3a7dd8e06b47dad85bab1e6b268a4379 100644 --- a/docs/repo-workspace.rst +++ b/docs/repo-workspace.rst @@ -52,7 +52,7 @@ On Ubuntu 20.04: $ sudo apt-get update $ sudo apt-get install git-repo -On distributions that use ``dnf``: +On Distributions that Use ``dnf``: ---------------------------------- .. code-block:: console @@ -100,7 +100,7 @@ Depending on the specific branch of the above-mentioned repository, that manifest may either allow some projects to follow changes by selecting git branches or pin all projects to a specific git commit revision. -Setting up the Workspace +Setting-up the Workspace ************************ Once the repo tool is installed, you can initialize and populate the workspace. @@ -112,7 +112,7 @@ This will bring in all the needed sources for building |main_project_name|: $ repo init -u https://booting.oniroproject.org/distro/oniro $ repo sync --no-clone-bundle -Workspace structure +Workspace Structure ******************* A fully set workspace, will provide a structure similar to: diff --git a/docs/supported-images.rst b/docs/supported-images.rst index 232862560a2389c00d19b10a6b56d88e626c5cf7..ba14057a0fcb7fa3c2d0955008fcf76fdc2cd948 100644 --- a/docs/supported-images.rst +++ b/docs/supported-images.rst @@ -4,7 +4,7 @@ .. include:: definitions.rst -Supported Images +Supported images ################ To create a custom Linux distribution to match the product requirements,