Browse Source

docs: split install into system-specific preparations and generic instructions

Thomas Waldmann 10 years ago
parent
commit
79d7f49a44
1 changed files with 40 additions and 50 deletions
  1. 40 50
      docs/installation.rst

+ 40 - 50
docs/installation.rst

@@ -14,6 +14,7 @@ Installation
 
 General notes
 -------------
+
 Even though Python 3 is not the default Python version on many systems, it is
 usually available as an optional install.
 
@@ -42,17 +43,15 @@ Mac OS X: You may need to get a recent enough OpenSSL version from homebrew_.
 Mac OS X: You need OS X FUSE >= 3.0.
 
 
-Debian Jessie / Ubuntu 14.04 installation (from git)
-----------------------------------------------------
-Note: this uses latest, unreleased development code from git.
-While we try not to break master, there are no guarantees on anything.
+Debian Jessie / Ubuntu 14.04 installation preparations (git)
+------------------------------------------------------------
 
 Some of the steps detailled below might be useful also for non-git installs.
 
 .. parsed-literal::
 
-    # Python 3.x (>= 3.2) + Headers, Py Package Installer
-    apt-get install python3 python3-dev python3-pip
+    # Python 3.x (>= 3.2) + Headers, Py Package Installer, VirtualEnv
+    apt-get install python3 python3-dev python3-pip python-virtualenv
 
     # we need OpenSSL + Headers for Crypto
     apt-get install libssl-dev openssl
@@ -75,35 +74,15 @@ Some of the steps detailled below might be useful also for non-git installs.
     # optional: for unit testing
     apt-get install fakeroot
 
-    # get |project_name| from github, install it
-    git clone |git_url|
-
-    apt-get install python-virtualenv
-    virtualenv --python=python3 borg-env
-    source borg-env/bin/activate   # always before using!
 
-    # install borg + dependencies into virtualenv
-    pip install cython  # compile .pyx -> .c
-    pip install tox pytest  # optional, for running unit tests
-    pip install sphinx  # optional, to build the docs
-    pip install llfuse  # optional, for FUSE support
-    cd borg
-    pip install -e .  # in-place editable mode
-
-    # optional: run all the tests, on all supported Python versions
-    fakeroot -u tox
-
-
-Korora / Fedora 21 installation (from git)
-------------------------------------------
-Note: this uses latest, unreleased development code from git.
-While we try not to break master, there are no guarantees on anything.
+Korora / Fedora 21 installation preparations (git)
+--------------------------------------------------
 
 Some of the steps detailled below might be useful also for non-git installs.
 
 .. parsed-literal::
-    # Python 3.x (>= 3.2) + Headers, Py Package Installer
-    sudo dnf install python3 python3-devel python3-pip
+    # Python 3.x (>= 3.2) + Headers, Py Package Installer, VirtualEnv
+    sudo dnf install python3 python3-devel python3-pip python3-virtualenv
 
     # we need OpenSSL + Headers for Crypto
     sudo dnf install openssl-devel openssl
@@ -120,27 +99,10 @@ Some of the steps detailled below might be useful also for non-git installs.
     # optional: for unit testing
     sudo dnf install fakeroot
 
-    # get |project_name| from github, install it
-    git clone |git_url|
-
-    dnf install python3-virtualenv
-    virtualenv --python=python3 borg-env
-    source borg-env/bin/activate   # always before using!
-
-    # install borg + dependencies into virtualenv
-    pip install cython  # compile .pyx -> .c
-    pip install tox pytest  # optional, for running unit tests
-    pip install sphinx  # optional, to build the docs
-    pip install llfuse  # optional, for FUSE support
-    cd borg
-    pip install -e .  # in-place editable mode
-
-    # optional: run all the tests, on all supported Python versions
-    fakeroot -u tox
 
+Cygwin installation preparations (git)
+--------------------------------------
 
-Cygwin (from git)
------------------
 Please note that running under cygwin is rather experimental, stuff has been
 tested with CygWin (x86-64) v2.1.0.
 
@@ -167,7 +129,7 @@ You can then install ``pip`` and ``virtualenv``:
     easy_install-3.4 pip
     pip install virtualenv
 
-And now continue as for Linux (see above).
+And now continue with the generic installation (see below).
 
 In case that creation of the virtual env fails, try deleting this file:
 
@@ -175,3 +137,31 @@ In case that creation of the virtual env fails, try deleting this file:
 
     /usr/lib/python3.4/__pycache__/platform.cpython-34.pyc
 
+
+Generic: Installing borgbackup (git)
+------------------------------------
+
+After you have done the installation preparations, you can now fetch and build
+|project_name|.
+
+Note: this uses latest, unreleased development code from git.
+While we try not to break master, there are no guarantees on anything.
+
+.. parsed-literal::
+    # get |project_name| from github, install it
+    git clone |git_url|
+
+    virtualenv --python=python3 borg-env
+    source borg-env/bin/activate   # always before using!
+
+    # install borg + dependencies into virtualenv
+    pip install cython  # compile .pyx -> .c
+    pip install tox pytest  # optional, for running unit tests
+    pip install sphinx  # optional, to build the docs
+    pip install llfuse  # optional, for FUSE support
+    cd borg
+    pip install -e .  # in-place editable mode
+
+    # optional: run all the tests, on all supported Python versions
+    fakeroot -u tox
+