summaryrefslogtreecommitdiff
path: root/docs/testers/howto.rst
diff options
context:
space:
mode:
authorTomás Touceda <chiiph@leap.se>2013-08-08 15:42:51 -0300
committerTomás Touceda <chiiph@leap.se>2013-08-08 15:42:51 -0300
commita6b994f9c201428097676fe914b55d50dfb07db7 (patch)
tree91486ca52fb4e77687cb724bfea4a65263b67830 /docs/testers/howto.rst
parente2e6e15fb6546890d39e427b43023bbcc4ceb75f (diff)
parent1f03efa202e4b604b9fb50d0742dc756691e9803 (diff)
Merge remote-tracking branch 'ivan/feature/3313_rebrand-leap-client-to-bitmask' into develop
Diffstat (limited to 'docs/testers/howto.rst')
-rw-r--r--docs/testers/howto.rst28
1 files changed, 14 insertions, 14 deletions
diff --git a/docs/testers/howto.rst b/docs/testers/howto.rst
index a3f8da09..520d9dd0 100644
--- a/docs/testers/howto.rst
+++ b/docs/testers/howto.rst
@@ -34,19 +34,19 @@ Bootstrap script
This will fetch the *develop* branch. If you want to test another branch, just change it in the line starting with *pip install...*. Alternatively, bug kali so she add an option branch to a decent script.
.. note::
- This script could make use of the after_install hook. Read http://pypi.python.org/pypi/virtualenv/
+ This script could make use of the after_install hook. Read http://pypi.python.org/pypi/virtualenv/
Download and source the following script in the parent folder where you want your testing build to be downloaded. For instance, to `/tmp/`:
.. code-block:: bash
cd /tmp
- wget https://raw.github.com/leapcode/leap_client/develop/pkg/scripts/leap_client_bootstrap.sh
+ wget https://raw.github.com/leapcode/bitmask/develop/pkg/scripts/leap_client_bootstrap.sh
source leap_client_bootstrap.sh
-Tada! If everything went well, you should be able to run the client by typing::
+Tada! If everything went well, you should be able to run bitmask by typing::
- bin/leap-client
+ bin/bitmask
Noticed that your prompt changed? That was *virtualenv*. Keep reading...
@@ -54,7 +54,7 @@ Activating the virtualenv
^^^^^^^^^^^^^^^^^^^^^^^^^
The above bootstrap script has fetched latest code inside a virtualenv, which is an isolated, *virtual* python local environment that avoids messing with your global paths. You will notice you are *inside* a virtualenv because you will see a modified prompt reminding it to you (*leap-client-testbuild* in this case).
-Thus, if you forget to *activate your virtualenv*, the client will not run from the local path, and it will be looking for something else in your global path. So, **you have to remember to activate your virtualenv** each time that you open a new shell and want to execute the code you are testing. You can do this by typing::
+Thus, if you forget to *activate your virtualenv*, bitmask will not run from the local path, and it will be looking for something else in your global path. So, **you have to remember to activate your virtualenv** each time that you open a new shell and want to execute the code you are testing. You can do this by typing::
$ source bin/activate
@@ -65,11 +65,11 @@ Refer to :ref:`Working with virtualenv <virtualenv>` to learn more about virtual
Copying config files
^^^^^^^^^^^^^^^^^^^^
-If you have never installed the ``leap-client`` globally, **you need to copy some files to its proper path before running it for the first time** (you only need to do this once). This, unless the virtualenv-based operations, will need root permissions. See :ref:`copy script files <copyscriptfiles>` and :ref:`running openvpn without root privileges <policykit>` sections for more info on this. In short::
+If you have never installed ``bitmask`` globally, **you need to copy some files to its proper path before running it for the first time** (you only need to do this once). This, unless the virtualenv-based operations, will need root permissions. See :ref:`copy script files <copyscriptfiles>` and :ref:`running openvpn without root privileges <policykit>` sections for more info on this. In short::
$ sudo cp pkg/linux/polkit/net.openvpn.gui.leap.policy /usr/share/polkit-1/actions/
$ sudo mkdir -p /etc/leap
- $ sudo cp pkg/linux/resolv-update /etc/leap
+ $ sudo cp pkg/linux/resolv-update /etc/leap
Local config files
^^^^^^^^^^^^^^^^^^^
@@ -83,8 +83,8 @@ Pulling latest changes
You should be able to cd into the downloaded repo and pull latest changes::
- (leap-client-testbuild)$ cd src/leap-client
- (leap-client-testbuild)$ git pull origin develop
+ (bitmask-testbuild)$ cd src/bitmask
+ (bitmask-testbuild)$ git pull origin develop
However, as a tester you are encouraged to run the whole bootstrap process from time to time to help us catching install and versioniing bugs too.
@@ -97,11 +97,11 @@ Testing the status of translations
We need translators! You can go to `transifex <https://www.transifex.com/projects/p/leap-client/>`_, get an account and start contributing.
-If you want to check the current status of the client localization in a language other than the one set in your machine, you can do it with a simple trick (under linux). For instance, do::
+If you want to check the current status of bitmask localization in a language other than the one set in your machine, you can do it with a simple trick (under linux). For instance, do::
- $ lang=es_ES leap-client
+ $ lang=es_ES bitmask
-for running LEAP Client with the spanish locales.
+for running Bitmask with the spanish locales.
Reporting bugs
--------------
@@ -110,6 +110,6 @@ Reporting bugs
There is a great text on the art of bug reporting, that can be found `online <http://www.chiark.greenend.org.uk/~sgtatham/bugs.html>`_.
-.. TODO add a line with ref. to running the client in debug mode...
+.. TODO add a line with ref. to running Bitmask in debug mode...
-We use the `LEAP Client Bug Tracker <https://leap.se/code/projects/eip-client>`_, although you can also use `Github issues <https://github.com/leapcode/leap_client/issues>`_.
+We use the `Bitmask Bug Tracker <https://leap.se/code/projects/eip-client>`_, although you can also use `Github issues <https://github.com/leapcode/bitmask/issues>`_.