From cac178a60c707029966d9c1edffb177d0a1c9976 Mon Sep 17 00:00:00 2001 From: Abraham Arce Date: Wed, 21 Nov 2018 03:20:16 -0600 Subject: [PATCH] [Bug] Missing items in build documentation Under section Installation Requirements and Dependencies on Developer Guide: - create a user - add the user to Docker group Closes-Bug: 1799611 Change-Id: I39e95b096bdf12f8ed76237066fc9a3f17cadcdb Signed-off-by: Abraham Arce --- doc/source/developer_guide/index.rst | 33 ++++++++++++++++++++++++---- 1 file changed, 29 insertions(+), 4 deletions(-) diff --git a/doc/source/developer_guide/index.rst b/doc/source/developer_guide/index.rst index 8c2e21f84..e53e592c8 100644 --- a/doc/source/developer_guide/index.rst +++ b/doc/source/developer_guide/index.rst @@ -66,17 +66,36 @@ You first need to update the local database list of available packages: Installation Requirements and Dependencies ****************************************** +^^^^ +User +^^^^ + +1. Make sure you are a non-root user with sudo enabled when you build the + StarlingX ISO. You also need to either use your existing user or create a + separate **: + + .. code:: sh + + $ sudo useradd -m -d /home/ + +2. Your ** should have sudo privileges: + + .. code:: sh + + $ sudo sh -c "echo ' ALL=(ALL:ALL) ALL' >> /etc/sudoers" + $ sudo su -c + ^^^ Git ^^^ -1. Install the required packages on the Ubuntu host system: +3. Install the required packages on the Ubuntu host system: .. code:: sh $ sudo apt-get install make git curl -2. Make sure to setup your identity with the following two commands. +4. Make sure to set up your identity using the following two commands. Be sure to provide your actual name and email address: .. code:: sh @@ -88,16 +107,22 @@ Git Docker CE ^^^^^^^^^ -3. Install the required Docker CE packages in the Ubuntu host system. See +5. Install the required Docker CE packages in the Ubuntu host system. See `Get Docker CE for Ubuntu `__ for more information. +6. Log out and log in to add your ** to the Docker group: + + .. code:: sh + + $ sudo usermod -aG docker + ^^^^^^^^^^^^^^^^^ Android Repo Tool ^^^^^^^^^^^^^^^^^ -4. Install the required Android Repo Tool in the Ubuntu host system. Follow +7. Install the required Android Repo Tool in the Ubuntu host system. Follow the steps in the `Installing Repo `__ section.