kallithea Changeset - 29e9cb56f26f

Changeset - 29e9cb56f26f

Parent rev.

Child rev.

[Not reviewed]

default

0 3 0

Thomas De Schampheleire - 8 years ago 2017-07-06 19:47:42
thomas.de.schampheleire@gmail.com

docs: recommend --upgrade for all pip installations in a virtualenv

As suggested by Mads Kiilerich.

Don't recommend this practice when no virtualenv is used, i.e. root
installation or --user installation: in this case upgrading existing packages
may be too disruptive. The user can still add it manually if he so chooses.

3 files changed with 8 insertions and 8 deletions:

docs/contributing.rst

docs/installation.rst

docs/upgrade.rst

0 comments (0 inline, 0 general)

docs/contributing.rst

➞

Show inline comments

@@ @@ -32,14 +32,14 @@ To get started with Kallithea developmen @@
         hg clone https://kallithea-scm.org/repos/kallithea
         cd kallithea
         virtualenv ../kallithea-venv
         source ../kallithea-venv/bin/activate
         pip install --upgrade pip setuptools
         pip install -e .
         pip install -r dev_requirements.txt
         pip install --upgrade -e .
         pip install --upgrade -r dev_requirements.txt
         gearbox make-config my.ini
         gearbox setup-db -c my.ini --user=user --email=user@example.com --password=password --repos=/tmp
         gearbox serve -c my.ini --reload &
         firefox http://127.0.0.1:5000/
 If you plan to use Bitbucket_ for sending contributions, you can also fork

docs/installation.rst

➞

Show inline comments

@@ @@ -53,13 +53,13 @@ repository, follow the instructions belo @@
         hg clone https://kallithea-scm.org/repos/kallithea -u stable
         cd kallithea
         virtualenv ../kallithea-venv
         . ../kallithea-venv/bin/activate
         pip install --upgrade pip setuptools
         pip install -e .
+        pip install --upgrade -e .
         python2 setup.py compile_catalog   # for translation of the UI
 You can now proceed to :ref:`setup`.
 .. _installation-virtualenv:
@@ @@ -88,31 +88,31 @@ An additional benefit of virtualenv_ is @@
    will "activate" a shell that terminates immediately. It is also perfectly
    acceptable (and desirable) to create a virtualenv as a normal user.
 .. note:: Some dependencies are optional. If you need them, install them in
    the virtualenv too::
      pip install psycopg2
      pip install python-ldap
      pip install --upgrade psycopg2
      pip install --upgrade python-ldap
    This might require installation of development packages using your
    distribution's package manager.
 - Make a folder for Kallithea data files, and configuration somewhere on the
   filesystem. For example::
     mkdir /srv/kallithea
 - Go into the created directory and run this command to install Kallithea::
     pip install kallithea
+    pip install --upgrade kallithea
   Alternatively, download a .tar.gz from http://pypi.python.org/pypi/Kallithea,
   extract it and run::
     pip install .
+    pip install --upgrade .
 - This will install Kallithea together with all other required
   Python libraries into the activated virtualenv.
 You can now proceed to :ref:`setup`.

docs/upgrade.rst

➞

Show inline comments

@@ @@ -82,13 +82,13 @@ If you originally installed using pip, i @@
     pip install --upgrade kallithea
 If you originally installed from version control, it is as simple as::
     cd my-kallithea-clone
     hg pull -u
     pip install -e .
+    pip install --upgrade -e .
 . Upgrade your configuration
 -----------------------------
 Run the following command to create a new configuration (``.ini``) file::

0 comments (0 inline, 0 general)