Update documentation to reflect new test commands

also updates the usage of new requirements files
Nitrate · Apr 13, 2017 · 4888d77 · 4888d77
1 parent 4fc4537
commit 4888d77
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 8 deletions.
diff --git a/docs/source/about.rst b/docs/source/about.rst
@@ -17,7 +17,7 @@ A brief history
 Dependencies
 ------------
 
-Basic dependences::
+Basic dependences (excluding database engine)::
 
     Python >= 2.6.5
 
@@ -26,4 +26,3 @@ Basic dependences::
 Additional recommended dependences for development:
 
 .. literalinclude:: ../../requirements/devel.txt
-
diff --git a/docs/source/contribution.rst b/docs/source/contribution.rst
@@ -20,6 +20,21 @@ on. Once you find a problem, please search it in the `Issues`_ to see whether
 it has been reported by other people. If no one reported there yet, you are
 encouraged to file one with detailed and descriptive description.
 
+Automated test suite can be execute with the ``make test`` command. The
+following syntax is supported::
+
+        make test (uses SQlite)
+        TEST_DB=MySQL make test
+        TEST_DB=MariaDB make test
+        TEST_DB=Postgres make test
+        TEST_DB=all make test (will test on all DBs)
+
+.. note::
+
+    If you want to execute testing against different DB engines on your local
+    development environment make sure the respecitve DB engines are installed
+    and configured! ``make test`` uses the configuration files under
+    ``tcms/settings/test/``. Make sure to edit them if necessary!
 
 Documentation
 -------------

diff --git a/docs/source/installing_in_rhel.rst b/docs/source/installing_in_rhel.rst
@@ -34,9 +34,13 @@ Install devel packages that should be installed first::
 
     sudo yum install gcc w3m python-devel mysql-devel krb5-devel libxml2-devel libxslt-devel
 
-Install dependencies from ``requirements/base.txt``::
+Install dependencies from ``requirements/mysql.txt``::
 
-    sudo pip install -r requirements/base.txt
+    sudo pip install -r requirements/mysql.txt
+
+.. note::
+
+    Alternatively you can use ``requirements/postgres.txt`` for PostgreSQL!
 
 Install from source code
 ~~~~~~~~~~~~~~~~~~~~~~~~

diff --git a/docs/source/installing_in_virtualenv.rst b/docs/source/installing_in_virtualenv.rst
@@ -42,14 +42,18 @@ dependencies. See :doc:`set_dev_env` for more information. Then::
     (venv)# git clone https://github.com/Nitrate/Nitrate.git
     (venv)# cd ./Nitrate/
     (venv)# git checkout --track [a proper tag or branch]
-    (venv)# pip install -r ./requirements/base.txt
+    (venv)# pip install -r ./requirements/mysql.txt
     (venv)# python setup.py install
 
 .. note::
 
     Nitrate source code has been cloned into your home directory but
     has been installed into the virtual environment for Apache!
 
+.. note::
+
+    Alternatively you can use ``requirements/postgres.txt`` for PostgreSQL!
+
 
 Initialize database
 -------------------

diff --git a/docs/source/set_dev_env.rst b/docs/source/set_dev_env.rst
@@ -21,16 +21,21 @@ Create a virtual environment for Nitrate::
 
     virtualenv ~/virtualenvs/nitrate
 
-Install dependencies from ``requirements/devel.txt``::
+Install dependencies for development::
 
     . ~/virtualenvs/nitrate/bin/activate
+    pip install -r requirements/mysql.txt
     pip install -r requirements/devel.txt
 
+.. note::
+
+    Alternatively you can use ``requirements/postgres.txt`` for PostgreSQL!
+
 Initialize database
 -------------------
 
-Currently, MySQL is only be supported, either mysql or mariadb is okay for
-running Nitrate.
+Currently we recommend either MySQL or MariaDB for running Nitrate. Support
+for PostgreSQL is still experimental.
 
 Create database and user::