From b04d1416804ba88fd37979cd2503b49117188c71 Mon Sep 17 00:00:00 2001
From: Sergei Trofimov <sergei.trofimov@arm.com>
Date: Mon, 23 Nov 2015 15:47:27 +0000
Subject: [PATCH] doc: updating installation instructions
Re-writing some of the instructions for clarity plus updating with the
correct pip invocations.
---
doc/source/installation.rst | 41 ++++++++++++++++++++++---------------
doc/source/quickstart.rst | 14 ++++---------
2 files changed, 29 insertions(+), 26 deletions(-)
diff --git a/doc/source/installation.rst b/doc/source/installation.rst
index 62c5f596..7c2fbf09 100644
--- a/doc/source/installation.rst
+++ b/doc/source/installation.rst
@@ -42,9 +42,8 @@ and add ``<path_to_android_sdk>/sdk/platform-tools`` and ``<path_to_android_sdk>
to your ``PATH``. To test that you've installed it properly, run ``adb
version``. The output should be similar to this::
- $$ adb version
+ adb version
Android Debug Bridge version 1.0.31
- $$
.. _here: https://developer.android.com/sdk/index.html
@@ -82,8 +81,8 @@ similar distributions, this may be done with APT::
is recommended that you update pip and setuptools before proceeding
with installation::
- sudo pip install --upgrade pip
- sudo pip install --upgrade setuptools
+ sudo -H pip install --upgrade pip
+ sudo -H pip install --upgrade setuptools
If you do run into this issue after already installing some packages,
you can resolve it by running ::
@@ -110,11 +109,11 @@ Workload Automation 2 depends on the following additional libraries:
You can install these with pip::
- sudo pip install pexpect
- sudo pip install pyserial
- sudo pip install pyyaml
- sudo pip install docutils
- sudo pip install python-dateutil
+ sudo -H pip install pexpect
+ sudo -H pip install pyserial
+ sudo -H pip install pyyaml
+ sudo -H pip install docutils
+ sudo -H pip install python-dateutil
Some of these may also be available in your distro's repositories, e.g. ::
@@ -157,13 +156,22 @@ may not always have Internet access).
Installing
==========
-.. note:: If you downloaded the Workload Automation source code from GitHub, open
- the README.rst file to start the setup process. A wlauto tarball will
- be created under the dist directory once the process is complete.
+Installing the latest released version from PyPI (Python Package Index)::
+
+ sudo -H pip install wlauto
+
+This will install WA along with its mandatory dependencies. If you would like to
+install all optional dependencies at the same time, do the following instead::
+
+ sudo -H pip install wlauto[all]
+
+Alternatively, you can also install the latest development version from GitHub
+(you will need git installed for this to work)::
+
+ git clone git@github.com:ARM-software/workload-automation.git workload-automation
+ sudo -H pip install ./workload-automation
-Download the tarball and run pip::
- sudo pip install wlauto-$version.tar.gz
If the above succeeds, try ::
@@ -300,13 +308,14 @@ that location.
If you have installed Workload Automation via ``pip`` and wish to remove it, run this command to
uninstall it::
- sudo pip uninstall wlauto
+ sudo -H pip uninstall wlauto
.. Note:: This will *not* remove any user configuration (e.g. the ~/.workload_automation directory)
+
(Optional) Upgrading
====================
To upgrade Workload Automation to the latest version via ``pip``, run::
- sudo pip install --upgrade --no-deps wlauto
+ sudo -H pip install --upgrade --no-deps wlauto
diff --git a/doc/source/quickstart.rst b/doc/source/quickstart.rst
index 038ae1c4..bc300f7b 100644
--- a/doc/source/quickstart.rst
+++ b/doc/source/quickstart.rst
@@ -27,18 +27,12 @@ WA uses a number of its utilities, not just adb. For the SDK, make sure that eit
In addition to the base Python 2.7 install, you will also need to have ``pip``
(Python's package manager) installed as well. This is usually a separate package.
-Once you have the prerequisites and a tarball with the workload automation package,
-you can install it with pip::
+Once you have those, you can install WA with::
- sudo pip install wlauto-$versiondev.tar.gz
+ sudo -H pip install wlauto
-Where $version is the current version of WA.
-
-.. note:: If you downloaded the Workload Automation source code from GitHub, open the
- README.rst file to start the setup process. A wlauto tarball will be created
- under the dist directory once the process is complete.
-
-This will install Workload Automation on your system, along with other dependencies.
+This will install Workload Automation on your system, along with its mandatory
+dependencies.
(Optional) Verify installation
-------------------------------