docs: Add a note about how to run tests

[patchwork] / docs / INSTALL

diff --git a/docs/INSTALL b/docs/INSTALL
index face0dc832ce22b33eba9f041ca9626a8c022807..d40ddd2e7d072528728dbee47c4204a45b36e2ac 100644 (file)
--- a/docs/INSTALL
+++ b/docs/INSTALL
@@ -52,16 +52,20 @@ in brackets):
         settings, using local_settings.py (see below) to override the defaults
         in settings.py:
 
-        DATABASE_ENGINE = 'postgresql_psycopg2'
-        DATABASE_NAME = 'patchwork'
-        DATABASE_USER = 'patchwork'
-        DATABASE_PASSWORD = 'my_secret_password
-        DATABASE_HOST = 'localhost'
-        DATABASE_PORT = ''
+        DATABASES = {
+            'default': {
+                'ENGINE': 'django.db.backends.postgresql_psycopg2',
+                'HOST': 'localhost',
+                'PORT': '',
+                'USER': 'patchwork',
+                'PASSWORD': 'my_secret_password',
+                'NAME': 'patchwork',
+            },
+        }
 
     For MySQL:
         $ mysql
-        > CREATE DATABASE 'patchwork';
+        > CREATE DATABASE 'patchwork' CHARACTER SET utf8;
         > CREATE USER 'www-data'@'localhost' IDENTIFIED BY '<password>';
         > CREATE USER 'nobody'@'localhost' IDENTIFIED BY '<password>';
 
@@ -69,12 +73,21 @@ in brackets):
        settings, using local_settings.py (see below) to override the defaults
        in settings.py:
 
-       DATABASE_ENGINE = 'mysql'
-       DATABASE_NAME = 'patchwork'
-       DATABASE_USER = 'root'
-       DATABASE_PASSWORD = 'my_secret_root_password'
-       DATABSE_HOST = 'localhost'
-       DATABASE_PORT = ''
+        DATABASES = {
+            'default': {
+                'ENGINE': 'django.db.backends.mysql',
+                'HOST': 'localhost',
+                'PORT': '',
+                'USER': 'patchwork',
+                'PASSWORD': 'my_secret_password',
+                'NAME': 'patchwork',
+                'TEST_CHARSET': 'utf8',
+            },
+        }
+
+        TEST_CHARSET is used when creating tables for the test suite. Without
+        it, tests checking for the correct handling of non-ASCII characters
+        fail.
 
 2. Django setup
 
@@ -113,13 +126,6 @@ in brackets):
           chars = string.letters + string.digits + string.punctuation
           print repr("".join([random.choice(chars) for i in range(0,50)]))
 
-        If you have patchwork installed in somewhere other than /srv/patchwork,
-        you'll also need to define:
-
-          ROOT_DIR
-          MEDIA_ROOT
-          TEMPLATE_DIRS
-
         If you wish to enable the XML-RPC interface, add the following to
         your local_settings.py file:
 
@@ -128,7 +134,7 @@ in brackets):
         Then, get patchwork to create its tables in your configured database:
 
          cd apps/
-         PYTHONPATH=../lib/python/django ./manage.py syncdb
+         PYTHONPATH=../lib/python ./manage.py syncdb
 
         And add privileges for your mail and web users. This is only needed if
         you use the ident-based approach. If you use password-based database