Changeset - 634c2fa427e8
[Not reviewed]
default
0 1 0
Thomas De Schampheleire - 7 years ago 2018-12-28 22:39:38
thomas.de_schampheleire@nokia.com
docs: upgrade: make upgrade instructions from version control more explicit

Instruct users to make a note of the orginal and new revision, both to help
in any failure analysis, and also to let them realize when the 'hg update'
command failed.
1 file changed with 6 insertions and 2 deletions:
0 comments (0 inline, 0 general)
docs/upgrade.rst
Show inline comments
 
@@ -60,52 +60,56 @@ database type, settings, location, etc.
 

	
 
3. Activate the Kallithea virtual environment (if any)
 
------------------------------------------------------
 

	
 
Verify that you are using the Python environment that you originally
 
installed Kallithea in by running::
 

	
 
    pip freeze
 

	
 
This will list all packages installed in the current environment. If
 
Kallithea isn't listed, activate the correct virtual environment.
 
See the appropriate installation page for details.
 

	
 

	
 
4. Install new version of Kallithea
 
-----------------------------------
 

	
 
Please refer to the instructions for the installation method you
 
originally used to install Kallithea.
 

	
 
If you originally installed using pip, it is as simple as::
 

	
 
    pip install --upgrade kallithea
 

	
 
If you originally installed from version control, it is as simple as::
 
If you originally installed from version control, assuming you did not make
 
private changes (in which case you should adapt the instructions accordingly)::
 

	
 
    cd my-kallithea-clone
 
    hg pull -u
 
    hg parent   # make a note of the original revision
 
    hg pull
 
    hg update
 
    hg parent   # make a note of the new revision
 
    pip install --upgrade -e .
 
    kallithea-cli front-end-build
 

	
 
.. _upgrade_config:
 

	
 

	
 
5. Upgrade your configuration
 
-----------------------------
 

	
 
Run the following command to create a new configuration (``.ini``) file::
 

	
 
    kallithea-cli config-create new.ini
 

	
 
Then compare it with your old config file and see what changed.
 

	
 
.. note::
 
    Please always make sure your ``.ini`` files are up to date. Errors
 
    can often be caused by missing parameters added in new versions.
 

	
 
.. _upgrade_db:
 

	
 

	
 
6. Upgrade your database
 
------------------------
0 comments (0 inline, 0 general)