summaryrefslogtreecommitdiff
path: root/docs/dev
diff options
context:
space:
mode:
authorKali Kaneko <kali@leap.se>2013-08-09 18:18:00 +0200
committerKali Kaneko <kali@leap.se>2013-08-09 18:18:00 +0200
commite3758f91f58d3a17032860bb17e1643c331c3b0f (patch)
tree7fb9d8e5a675a093443a4224b0fd70c26d437b0c /docs/dev
parent275109e17f53c2fceb21d6f87626762800f53e22 (diff)
parentb942468aac94be2bf4bb9bc1849391e72c366697 (diff)
Merge remote-tracking branch 'chiiph/feature/relnotes' into develop
Diffstat (limited to 'docs/dev')
-rw-r--r--docs/dev/environment.rst14
-rw-r--r--docs/dev/internals.rst2
-rw-r--r--docs/dev/internationalization.rst20
-rw-r--r--docs/dev/tests.rst4
4 files changed, 20 insertions, 20 deletions
diff --git a/docs/dev/environment.rst b/docs/dev/environment.rst
index 010ccc83..7ce536f9 100644
--- a/docs/dev/environment.rst
+++ b/docs/dev/environment.rst
@@ -3,7 +3,7 @@
Setting up a development environment
====================================
-This document covers how to get an enviroment ready to contribute code to the LEAP Client.
+This document covers how to get an enviroment ready to contribute code to Bitmask.
Cloning the repo
----------------
@@ -13,12 +13,12 @@ Cloning the repo
::
- git clone git://leap.se/leap_client
+ git clone git://leap.se/bitmask
git checkout develop
Base Dependencies
------------------
-Leap client depends on these libraries:
+Bitmask depends on these libraries:
* `python 2.6 or 2.7`
* `qt4` libraries (see also :ref:`Troubleshooting PySide install <pysidevirtualenv>` about how to install inside your virtualenv)
@@ -100,10 +100,10 @@ You can install python dependencies with ``pip``. If you do it inside your worki
Copy script files
-----------------
-The openvpn invocation expects some files to be in place. If you have not installed `leap-client` from a debian package, you must copy these files manually by now::
+The openvpn invocation expects some files to be in place. If you have not installed `bitmask` from a debian package, you must copy these files manually by now::
$ sudo mkdir -p /etc/leap
- $ sudo cp pkg/linux/resolv-update /etc/leap
+ $ sudo cp pkg/linux/resolv-update /etc/leap
.. _policykit:
@@ -111,9 +111,9 @@ Running openvpn without root privileges
---------------------------------------
In linux, we are using ``policykit`` to be able to run openvpn without root privileges, and a policy file is needed to be installed for that to be possible.
-The setup script tries to install the policy file when installing the client system-wide, so if you have installed the client in your global site-packages at least once it should have copied this file for you.
+The setup script tries to install the policy file when installing bitmask system-wide, so if you have installed bitmask in your global site-packages at least once it should have copied this file for you.
-If you *only* are running the client from inside a virtualenv, you will need to copy this file by hand::
+If you *only* are running bitmask from inside a virtualenv, you will need to copy this file by hand::
$ sudo cp pkg/linux/polkit/net.openvpn.gui.leap.policy /usr/share/polkit-1/actions/
diff --git a/docs/dev/internals.rst b/docs/dev/internals.rst
index 8bb19211..e43868f3 100644
--- a/docs/dev/internals.rst
+++ b/docs/dev/internals.rst
@@ -3,7 +3,7 @@
Internals
=========
-This section covers briefly the internal organization of the LEAP Client source tree.
+This section covers briefly the internal organization of Bitmask source tree.
.. note::
diff --git a/docs/dev/internationalization.rst b/docs/dev/internationalization.rst
index 8c584fdd..f9f522b9 100644
--- a/docs/dev/internationalization.rst
+++ b/docs/dev/internationalization.rst
@@ -3,15 +3,15 @@
Internationalization
====================
-This part of the documentation covers the localization and translation of LEAP Client.
+This part of the documentation covers the localization and translation of Bitmask.
Because we want to *bring fire to the people*, in as many countries and languages as possible.
-Translating the LEAP Client PySide Application
---------------------------------------------
+Translating Bitmask PySide Application
+--------------------------------------
.. raw:: html
- <div><a target="_blank" style="text-decoration:none; color:black; font-size:66%" href="https://www.transifex.com/projects/p/leap-client/resource/leap-client/" title="See more information on Transifex.com">Top translations: leap-client » leap-client</a><br/><img border="0" src="https://www.transifex.com/projects/p/leap-client/resource/leap-client/chart/image_png"/><br/><a target="_blank" href="https://www.transifex.com/"><img border="0" src="https://ds0k0en9abmn1.cloudfront.net/static/charts/images/tx-logo-micro.646b0065fce6.png"/></a></div>
+ <div><a target="_blank" style="text-decoration:none; color:black; font-size:66%" href="https://www.transifex.com/projects/p/bitmask/resource/bitmask/" title="See more information on Transifex.com">Top translations: bitmask » bitmask</a><br/><img border="0" src="https://www.transifex.com/projects/p/bitmask/resource/bitmask/chart/image_png"/><br/><a target="_blank" href="https://www.transifex.com/"><img border="0" src="https://ds0k0en9abmn1.cloudfront.net/static/charts/images/tx-logo-micro.646b0065fce6.png"/></a></div>
For translators
@@ -21,7 +21,7 @@ For translators
as internal notes.
-We are using `transifex <http://transifex.com/projects/p/leap-client>`_ to coordinate translation efforts. If you want to contribute, just sign up there and ...
+We are using `transifex <http://transifex.com/projects/p/bitmask>`_ to coordinate translation efforts. If you want to contribute, just sign up there and ...
.. note::
... and what??
@@ -61,11 +61,11 @@ You need ``pyside-lupdate`` and ``lrelease`` for these steps. To get it, in debi
If you do not already have it, install the ``transifex-client`` from the cheese shop::
- pip install transifex-client
+ pip install transifex-client
You can learn more about the transifex-client `here <http://help.transifex.com/features/client/index.html>`_.
-**1.** Add any new source files to the project file, ``data/leap_client.pro``. *We should automate this with some templating, it's tedious.*
+**1.** Add any new source files to the project file, ``data/bitmask.pro``. *We should automate this with some templating, it's tedious.*
**2.** Update the source .ts file ``data/ts/en_US.ts``.::
@@ -80,7 +80,7 @@ You can learn more about the transifex-client `here <http://help.transifex.com/f
**5.** *Et voila!* Get updated .ts files for each language from ``Transifex``. For instance, to pull updated spanish translations::
$ tx pull -l es
- Pulling new translations for resource leap-client.leap-client (source: data/ts/en_US.ts)
+ Pulling new translations for resource bitmask.bitmask (source: data/ts/en_US.ts)
-> es: data/translations/es.ts
Done.
@@ -89,7 +89,7 @@ Note that there is a configuration option in ``.tx/config`` for setting the mini
**6.** Generate .qm files from the updated .ts files::
- $ make translations
+ $ make translations
and yes, it's the same command than in step 2. One less thing to remember :)
@@ -101,7 +101,7 @@ and yes, it's the same command than in step 2. One less thing to remember :)
If you want to try it, just set your LANG environment variable::
- $ LANG=es_ES leap-client
+ $ LANG=es_ES bitmask
Translating the Documentation
diff --git a/docs/dev/tests.rst b/docs/dev/tests.rst
index 7f5fbaaf..d55c206a 100644
--- a/docs/dev/tests.rst
+++ b/docs/dev/tests.rst
@@ -39,8 +39,8 @@ Hint: colorized output
Install ``rednose`` locally, export the ``NOSE_REDNOSE`` variable, and give your eyes a rest :)::
- (leap_client)% pip install rednose
- (leap_client)% export NOSE_REDNOSE=1
+ (bitmask)% pip install rednose
+ (bitmask)% export NOSE_REDNOSE=1
Testing all the supported python versions
-----------------------------------------