diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/dev/environment.rst | 10 | ||||
| -rw-r--r-- | docs/man/bitmask.1.rst | 2 | ||||
| -rw-r--r-- | docs/release_checklist.wiki | 24 | ||||
| -rw-r--r-- | docs/testers/howto.rst | 7 | ||||
| -rw-r--r-- | docs/user/install.rst | 6 |
5 files changed, 29 insertions, 20 deletions
diff --git a/docs/dev/environment.rst b/docs/dev/environment.rst index 7ce536f9..e942b1cb 100644 --- a/docs/dev/environment.rst +++ b/docs/dev/environment.rst @@ -13,9 +13,11 @@ Cloning the repo :: - git clone git://leap.se/bitmask + git clone git://leap.se/bitmask_client git checkout develop +.. XXX change this when repo changes. + Base Dependencies ------------------ Bitmask depends on these libraries: @@ -121,6 +123,10 @@ If you *only* are running bitmask from inside a virtualenv, you will need to cop Missing Authentication agent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -If you are running a desktop other than gnome or unity, you might get an error saying that you are not running the authentication agent. You can launch it like this:: +If you are using linux and running a desktop other than unity or gnome, you might get an error saying that you are not running the authentication agent. For systems with gnome libraries installed you can launch it like this:: /usr/lib/policykit-1-gnome/polkit-gnome-authentication-agent-1 & + +or if you are a kde user:: + + /usr/lib/kde4/libexec/polkit-kde-authentication-agent-1 & diff --git a/docs/man/bitmask.1.rst b/docs/man/bitmask.1.rst index 7a1d2ae1..ed4f7133 100644 --- a/docs/man/bitmask.1.rst +++ b/docs/man/bitmask.1.rst @@ -38,6 +38,8 @@ general options **-s, --standalone** Makes Bitmask use standalone directories for configuration and binary searching. +**-V, --version** Displays Bitmask version and exits. + openvpn options --------------- diff --git a/docs/release_checklist.wiki b/docs/release_checklist.wiki index e6467048..19a19289 100644 --- a/docs/release_checklist.wiki +++ b/docs/release_checklist.wiki @@ -2,12 +2,12 @@ * [ ] Check that all tests are passing! * [ ] Tag everything * Should be done for the following packages, in order: - 1. leap.common - 2. leap.keymanager - 3. leap.soledad - 4. leap.mail - 5. leap.bitmask - 6. leap.mx + * [ ] 1. leap.common + * [ ] 2. leap.keymanager + * [ ] 3. leap.soledad + * [ ] 4. leap.mail + * [ ] 5. leap.bitmask + * [ ] 6. leap.mx * NOTE: It's assumed that origin is the leap.se repo * [ ] git fetch origin * [ ] git tag -l, and see the latest tagged version (unless it's not a minor version bump, in which case, just bump to it) @@ -17,17 +17,17 @@ - Helper bash line: for i in $(ls changes); do cat changes/$i; echo; done * [ ] Update relnotes.txt if needed. * [ ] git rm changes/* - * [ ] git commit -av * [ ] Review pkg/requirements.pip for everything and update if needed (that's why the order). - See whatever has been introduced in changes/VERSION_COMPAT - Reset changes/VERSION_COMPAT - * [ ] git tag -s X.Y.Z (note the -s so that it's a signed tag) The message should be something like: Tag <package> version X.Y.Z + * [ ] git commit -av # we should add a commit message here... + * [ ] git checkout master && git pull origin master && git merge --no-ff release-X.Y.Z && git push origin master + * [ ] git tag -s X.Y.Z -m "Tag <package> version X.Y.Z" # (note the -s so that it's a signed tag and -m to specify the message for the tag) * [ ] git push origin X.Y.Z - * [ ] git checkout master && git pull origin master && git merge release-X.Y.Z && git push origin master - * [ ] git checkout develop && git pull origin develop && git merge release-X.Y.Z && git push origin develop + * [ ] git checkout develop && git merge master && git push origin develop * [ ] Build and upload bundles * [ ] Use the scripts under pkg/<os>/ to build the the bundles. - * [ ] Sign them with gpg -a <path/to/bundle> + * [ ] Sign them with gpg -a --sign --detach-sign <path/to/bundle> * [ ] Upload bundle and signature to web-uploads@salmon.leap.se:~/public/client/<os>/Bitmask-<os>-<ver>.(tar.bz2,dmg,zip) * [ ] Update symbolic link for latest upload and signature: * [ ] ~/public/client/Bitmask-<os>-latest @@ -38,3 +38,5 @@ Notes ----- (*) this checklist kindly borrowed from tahoe-lafs documentation =) + +For a good reference look at http://nvie.com/posts/a-successful-git-branching-model/ diff --git a/docs/testers/howto.rst b/docs/testers/howto.rst index 9c6561ed..61d38787 100644 --- a/docs/testers/howto.rst +++ b/docs/testers/howto.rst @@ -25,8 +25,9 @@ Install dependencies ^^^^^^^^^^^^^^^^^^^^ First, install all the base dependencies plus git, virtualenv and development files needed to compile several extensions:: - apt-get install openvpn git-core python-dev python-qt4 python-setuptools python-virtualenv + apt-get install openvpn git-core python-dev python-pyside python-setuptools python-virtualenv +.. TODO Should review these dependencies. ^^ Bootstrap script ^^^^^^^^^^^^^^^^ @@ -41,12 +42,12 @@ Download and source the following script in the parent folder where you want you .. code-block:: bash cd /tmp - wget https://raw.github.com/leapcode/leap_client/develop/pkg/scripts/bitmask_bootstrap.sh + wget https://raw.github.com/leapcode/bitmask_client/develop/pkg/scripts/bitmask_bootstrap.sh source bitmask_bootstrap.sh Tada! If everything went well, you should be able to run bitmask by typing:: - bin/bitmask + bitmask Noticed that your prompt changed? That was *virtualenv*. Keep reading... diff --git a/docs/user/install.rst b/docs/user/install.rst index 81807a43..e5765302 100644 --- a/docs/user/install.rst +++ b/docs/user/install.rst @@ -88,15 +88,13 @@ Installing Bitmask is as simple as using `pip <http://www.pip-installer.org/>`_ Show me the code! ----------------- -.. XXX UPDATE REPO NAMES AS SOON AS #3417 is DONE - You can get the code from LEAP public git repository :: - $ git clone git://leap.se/leap_client + $ git clone git://leap.se/bitmask_client Or from the github mirror :: - $ git clone git://github.com/leapcode/leap_client.git + $ git clone git://github.com/leapcode/bitmask_client.git Once you have grabbed a copy of the sources, you can install it into your site-packages easily :: |