aboutsummaryrefslogtreecommitdiffstats
path: root/docs/userguides/installation.rst
diff options
context:
space:
mode:
authorMaryam Tahhan <maryam.tahhan@intel.com>2015-12-16 13:43:37 +0000
committerMaryam Tahhan <maryam.tahhan@intel.com>2015-12-23 10:32:18 +0000
commit00985d31991a1e1b91fcff87e82ff99957611396 (patch)
treecc90decccf1301213f6438b9719fb5f499608d96 /docs/userguides/installation.rst
parentcc3a4bf85074989c28a09b7b141dea5e42701f5c (diff)
docs: update userguides after reviewing
Review and update userguides for Release B. JIRA: VSPERF-160 Change-Id: I54c4dd37fa5951cab9d0e17bb2f3a4d273741cb0 Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>
Diffstat (limited to 'docs/userguides/installation.rst')
-rwxr-xr-xdocs/userguides/installation.rst16
1 files changed, 11 insertions, 5 deletions
diff --git a/docs/userguides/installation.rst b/docs/userguides/installation.rst
index 96970bdb..bd47519a 100755
--- a/docs/userguides/installation.rst
+++ b/docs/userguides/installation.rst
@@ -17,21 +17,26 @@ Execution of installation script:
.. code:: bash
- cd systems
- ./build_base_machine.sh
+ $ cd systems
+ $ ./build_base_machine.sh
Please note: you don't need to go into any of the systems subdirectories,
simply run the top level build_base_machine.sh, your OS will be detected
automatically.
+build_base_machine.sh will install all the vsperf dependencies in terms of
+system packages and Python modules, it will also use `virtualenv`_ to create a
+vsperf virtual environment that's isolated from the default Python env. This
+environment will reside in a directory called vsperfenv in $HOME.
+
You will need to activate the virtual environment every time you start a
new shell session. To activate, simple run:
.. code:: bash
- scl enable python33 bash
- cd $HOME/vsperfenv
- source bin/activate
+ $ scl enable python33 bash
+ $ cd $HOME/vsperfenv
+ $ source bin/activate
--------------
@@ -47,3 +52,4 @@ running any of the above. For example:
export https_proxy=proxy.mycompany.com:123
.. _a link: http://www.softwarecollections.org/en/scls/rhscl/python33/
+.. _virtualenv: https://virtualenv.readthedocs.org/en/latest/