Mercurial > kallithea

changeset 7490:14e8dcffd279

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs: upgrade: clarify database upgrade instructions Alembic should be called with the new configuration file, which the instructions already created as 'new.ini'.
author Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
date Fri, 28 Dec 2018 22:38:02 +0100
parents 445d6875c2ee
children 634c2fa427e8
files docs/upgrade.rst
diffstat 1 files changed, 12 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/docs/upgrade.rst	Wed Dec 26 21:39:32 2018 +0100
+++ b/docs/upgrade.rst	Fri Dec 28 22:38:02 2018 +0100
@@ -88,6 +88,8 @@
     pip install --upgrade -e .
     kallithea-cli front-end-build
 
+.. _upgrade_config:
+
 
 5. Upgrade your configuration
 -----------------------------
@@ -116,7 +118,7 @@
 
 First, run the following command to see your current database version::
 
-    alembic -c my.ini current
+    alembic -c new.ini current
 
 Typical output will be something like "9358dc3d6828 (head)", which is
 the current Alembic database "revision ID". Write down the entire output
@@ -129,12 +131,12 @@
 Next, if you are performing an *upgrade*: Run the following command to
 upgrade your database to the current Kallithea version::
 
-    alembic -c my.ini upgrade head
+    alembic -c new.ini upgrade head
 
 If you are performing a *downgrade*: Run the following command to
 downgrade your database to the given version::
 
-    alembic -c my.ini downgrade 0.4
+    alembic -c new.ini downgrade 0.4
 
 Alembic will show the necessary migrations (if any) as it executes them.
 If no "ERROR" is displayed, the command was successful.
@@ -151,6 +153,13 @@
 
     FAILED: No config file 'my.ini' found, or file has no '[alembic]' section
 
+.. note::
+    If you followed this upgrade guide correctly, you will have created a
+    new configuration file in section :ref:`Upgrading your configuration
+    <upgrade_config>`. When calling Alembic, make
+    sure to use this new config file. In this case, you should not get any
+    errors and the below manual steps should not be needed.
+
 If Alembic complains specifically about a missing ``alembic.ini``, it is
 likely because you did not specify a config file using the ``-c`` option.
 On the other hand, if the mentioned config file actually exists, you