From 376aaab9271c30878f21c3e59264a593f8717ab4 Mon Sep 17 00:00:00 2001
From: Gururaj Shetty <gururaj.shetty@huawei.com>
Date: Tue, 14 Dec 2021 16:31:09 +0530
Subject: [PATCH] docs: Title Case Heading
Convert all headings into title case.
Closes: https://booting.oniroproject.org/distro/oniro/-/issues/204
Signed-off-by: Gururaj Shetty <gururaj.shetty@huawei.com>
---
docs/README.md | 2 +-
docs/fallback-devices-support.rst | 2 +-
docs/hardware-support/boards/96b-Avenger.rst | 8 ++++----
docs/hardware-support/boards/96b-nitrogen.rst | 8 ++++----
docs/hardware-support/boards/arduino-nano-33-ble.rst | 6 +++---
docs/hardware-support/boards/nRF52840-DK.rst | 6 +++---
docs/hardware-support/boards/raspberrypi4.rst | 6 +++---
docs/hardware-support/boards/seco-imx8mm-c61.rst | 4 ++--
docs/hardware-support/boards/seco-intel-b68.rst | 6 +++---
docs/hardware-support/index.rst | 2 +-
docs/hardware-support/virtual-boards/qemux86-64.rst | 2 +-
docs/hardware-support/virtual-boards/qemux86.rst | 2 +-
docs/oniro-build/visual-customizations.rst | 4 ++--
docs/oniro-quick-build.rst | 4 ++--
docs/repo-workspace.rst | 6 +++---
docs/supported-images.rst | 2 +-
16 files changed, 35 insertions(+), 35 deletions(-)
diff --git a/docs/README.md b/docs/README.md
index 798c6330..3ae1cab3 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 6975bb96..1c6ad699 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 5e178c7e..f2183eab 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 f95a2eb5..6a7794ee 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 ca3679f5..805d7df5 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 3ae268f0..25a622fa 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 8451e38f..3027f50c 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 bd1ec9a4..cfbb8960 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 dc853b3a..53741c13 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 b89afad0..781e2f31 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 bb4e3452..2797263e 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 5c7e45a8..c7e72b05 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 729893b6..7fde6082 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 21f346f4..f8d95069 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 3b369b28..7a12c26a 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 23286256..ba14057a 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,
--
GitLab