sascha/workload-automation
1
0
Fork 0
mirror of https://github.com/ARM-software/workload-automation.git synced 2025-02-07 13:41:24 +00:00
Code Issues Releases Wiki Activity

doc/source: Add details about running WA on Linux

Browse Source 
Mention in the documentation that Android SDK is optional for
users who plan to run WA on Linux devices only, and how they
would only be able to start running a limited number of workloads.

Also included a few trivial fixes such as spelling errors and
moving sentences around to improve flow.

Signed-off-by: Lisa Nguyen <lisa.nguyen@linaro.org>
This commit is contained in:
Lisa Nguyen 2015-04-10 05:35:44 +01:00 committed by Sergei Trofimov
parent e37bf90da7
commit b41d316fd6
2 changed files with 28 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
doc/source/installation.rst
View File

@ -15,16 +15,23 @@ Operating System
WA runs on a native Linux install. It was tested with Ubuntu 12.04, WA runs on a native Linux install. It was tested with Ubuntu 12.04,
but any recent Linux distribution should work. It should run on either but any recent Linux distribution should work. It should run on either
32bit or 64bit OS, provided the correct version of Android (see below) 32-bit or 64-bit OS, provided the correct version of Android (see below)
was installed. Officially, **other environments are not supported**. WA was installed. Officially, **other environments are not supported**. WA
has been known to run on Linux Virtual machines and in Cygwin environments, has been known to run on Linux Virtual machines and in Cygwin environments,
though additional configuration maybe required in both cases (known issues though additional configuration may be required in both cases (known issues
include makings sure USB/serial connections are passed to the VM, and wrong include makings sure USB/serial connections are passed to the VM, and wrong
python/pip binaries being picked up in Cygwin). WA *should* work on other python/pip binaries being picked up in Cygwin). WA *should* work on other
Unix-based systems such as BSD or Mac OS X, but it has not been tested Unix-based systems such as BSD or Mac OS X, but it has not been tested
in those environments. WA *does not* run on Windows (though it should be in those environments. WA *does not* run on Windows (though it should be
possible to get limited functionality with minimal porting effort). possible to get limited functionality with minimal porting effort).
.. Note:: If you plan to run Workload Automation on Linux devices only,
SSH is required, and Android SDK is optional if you wish
to run WA on Android devices at a later time. Then follow the
steps to install the necessary python packages to set up WA.
However, you would be starting off with a limited number of
workloads that will run on Linux devices.
Android SDK Android SDK
----------- -----------
@ -32,8 +39,8 @@ Android SDK
You need to have the Android SDK with at least one platform installed. You need to have the Android SDK with at least one platform installed.
To install it, download the ADT Bundle from here_. Extract it To install it, download the ADT Bundle from here_. Extract it
and add ``<path_to_android_sdk>/sdk/platform-tools`` and ``<path_to_android_sdk>/sdk/tools`` and add ``<path_to_android_sdk>/sdk/platform-tools`` and ``<path_to_android_sdk>/sdk/tools``
to your ``PATH``. To test that you've installed it properly run ``adb to your ``PATH``. To test that you've installed it properly, run ``adb
version``, the output should be similar to this:: version``. The output should be similar to this::
$$ adb version $$ adb version
Android Debug Bridge version 1.0.31 Android Debug Bridge version 1.0.31
@ -57,7 +64,7 @@ the install location of the SDK (i.e. ``<path_to_android_sdk>/sdk``).
Python Python
------ ------
Workload Automation 2 requires Python 2.7 (Python 3 is not supported, at the moment). Workload Automation 2 requires Python 2.7 (Python 3 is not supported at the moment).
pip pip
@ -133,6 +140,10 @@ may not always have Internet access).
Installing 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.
Download the tarball and run pip:: Download the tarball and run pip::
sudo pip install wlauto-$version.tar.gz sudo pip install wlauto-$version.tar.gz

21
doc/source/quickstart.rst
View File

@ -13,17 +13,20 @@ Install
the :doc:`installation` section. the :doc:`installation` section.
Make sure you have Python 2.7 and a recent Android SDK with API level 18 or above Make sure you have Python 2.7 and a recent Android SDK with API level 18 or above
installed on your system. For the SDK, make sure that either ``ANDROID_HOME`` installed on your system. A complete install of the Android SDK is required, as
environment variable is set, or that ``adb`` is in your ``PATH``. WA uses a number of its utilities, not just adb. For the SDK, make sure that either
``ANDROID_HOME`` environment variable is set, or that ``adb`` is in your ``PATH``.
.. note:: A complete install of the Android SDK is required, as WA uses a .. Note:: If you plan to run Workload Automation on Linux devices only, SSH is required,
number of its utilities, not just adb. and Android SDK is optional if you wish to run WA on Android devices at a
later time.
However, you would be starting off with a limited number of workloads that
will run on Linux devices.
In addition to the base Python 2.7 install, you will also need to have ``pip`` 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. (Python's package manager) installed as well. This is usually a separate package.
.. note:: For Linux, SSH is also required.
Once you have the prerequisites and a tarball with the workload automation package, Once you have the prerequisites and a tarball with the workload automation package,
you can install it with pip:: you can install it with pip::
@ -31,9 +34,9 @@ you can install it with pip::
Where $version is the current version of WA. Where $version is the current version of WA.
.. note:: If you downloaded the Workload Automation source code from GitHub, open .. note:: If you downloaded the Workload Automation source code from GitHub, open the
the README.rst file to start the setup process. A wlauto tarball will README.rst file to start the setup process. A wlauto tarball will be created
be created under the dist directory once the process is complete. 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 other dependencies.