From 1b377271c6d15e0769b3e8fa86e0ab6884f2e384 Mon Sep 17 00:00:00 2001
From: Andrei Gherzan <andrei.gherzan@huawei.com>
Date: Mon, 29 Mar 2021 17:36:28 +0100
Subject: [PATCH] docs: Clarify that Ubuntu is just an example of a supported
distro
Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>
---
docs/openharmony-quick-build.rst | 7 +++++--
docs/repo-workspace.rst | 10 ++++++----
2 files changed, 11 insertions(+), 6 deletions(-)
diff --git a/docs/openharmony-quick-build.rst b/docs/openharmony-quick-build.rst
index b8464d9a..aa16c7a2 100644
--- a/docs/openharmony-quick-build.rst
+++ b/docs/openharmony-quick-build.rst
@@ -19,7 +19,7 @@ of OpenHarmony on a real hardware, checkout the :ref:`Avenger96 support page
Prerequisites
*************
-Have a **Ubuntu 20.04 LTS** host with all the required host packages.
+Install all the required host packages. Here is an example for **Ubuntu**:
.. code-block:: console
@@ -28,11 +28,14 @@ Have a **Ubuntu 20.04 LTS** host with all the required host packages.
xz-utils debianutils iputils-ping python3-git python3-jinja2 libegl1-mesa libsdl1.2-dev \
pylint3 xterm
+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
*******************************
-Install Google git repo tool:
+Install Google git repo tool. For example, on **Ubuntu 20.04**, you can do this
+by:
.. code-block:: console
diff --git a/docs/repo-workspace.rst b/docs/repo-workspace.rst
index 69093274..d16e9deb 100644
--- a/docs/repo-workspace.rst
+++ b/docs/repo-workspace.rst
@@ -17,11 +17,13 @@ building OpenHarmony and developing on top.
The Repo Tool
*************
-OpenHarmony provides a patched version of the repo tool published as a
-`launchpad PPA <https://launchpad.net/~openharmony/+archive/ubuntu/tools>`_.
-The patches are also available in the tool's `source repository <https://git.ostc-eu.org/OSTC/packaging/git-repo>`_.
+In order to setup a sources workspace of OpenHarmony, the ``git-repo`` tool is
+required on the host.
-Install this tool by following the next steps:
+For ``Ubuntu 20.04``, OpenHarmony provides a patched version of the repo tool
+published as a `launchpad PPA <https://launchpad.net/~openharmony/+archive/ubuntu/tools>`_.
+The patches are also available in the tool's `source repository <https://git.ostc-eu.org/OSTC/packaging/git-repo>`_.
+One can install this tool by following the next steps:
.. code-block:: console
--
GitLab