kallithea Changeset - 14e8dcffd279

Changeset - 14e8dcffd279

Parent rev.

Child rev.

[Not reviewed]

default

0 1 0

Thomas De Schampheleire - 7 years ago 2018-12-28 22:38:02
thomas.de_schampheleire@nokia.com

docs: upgrade: clarify database upgrade instructions

Alembic should be called with the new configuration file, which the
instructions already created as 'new.ini'.

1 file changed with 12 insertions and 3 deletions:

docs/upgrade.rst

0 comments (0 inline, 0 general)

docs/upgrade.rst

➞

Show inline comments

@@ @@ -85,12 +85,14 @@ If you originally installed from version @@
     cd my-kallithea-clone
     hg pull -u
     pip install --upgrade -e .
     kallithea-cli front-end-build
 .. _upgrade_config:
 . Upgrade your configuration
 -----------------------------
 Run the following command to create a new configuration (``.ini``) file::
@@ @@ -113,31 +115,31 @@ Then compare it with your old config fil @@
     migration step *before* installing the older version. (That is,
     always perform migrations using the most recent of the two versions
     you're migrating between.)
 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
 for troubleshooting purposes.
 The output will be empty if you're upgrading from Kallithea 0.3.x or
 older. That's expected. If you get an error that the config file was not
 found or has no ``[alembic]`` section, see the next section.
 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.
 Should an error occur, the database may be "stranded" half-way
 through the migration, and you should restore it from backup.
@@ @@ -148,12 +150,19 @@ Enabling old Kallithea config files for @@
 Kallithea configuration files created before the introduction of Alembic
 (i.e. predating Kallithea 0.4) need to be updated for use with Alembic.
 Without this, Alembic will fail with an error like this::
     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
 need to append the following lines to it::
     [alembic]

0 comments (0 inline, 0 general)