cleaned up configuration file handling and documented the new behaviour

2 files changed, 13 insertions, 16 deletions

diff --git a/doc/advopt.txt b/doc/advopt.txt
index c7dee653f..b43e5e511 100755
--- a/doc/advopt.txt
+++ b/doc/advopt.txt
@@ -52,8 +52,9 @@ Advanced options:
   --taintMode:on|off        turn taint mode on|off
   --symbolFiles:on|off      turn symbol files on|off (experimental)
   --skipCfg                 do not read the general configuration file
-  --skipProjCfg             do not read the project's configuration file
   --skipUserCfg             do not read the user's configuration file
+  --skipParentCfg           do not read the parent dirs' configuration files
+  --skipProjCfg             do not read the project's configuration file
   --gc:refc|boehm|none      use Nimrod's native GC|Boehm GC|no GC
   --index:FILE              use FILE to generate a documentation index file
   --putenv:key=value        set an environment variable
diff --git a/doc/nimrodc.txt b/doc/nimrodc.txt
index 08128521f..5a716fda0 100755
--- a/doc/nimrodc.txt
+++ b/doc/nimrodc.txt
@@ -37,25 +37,21 @@ Advanced command line switches are:
 .. include:: advopt.txt

 

 

-Configuration file

-------------------

-The default configuration file is ``nimrod.cfg``. The ``nimrod`` executable

-looks for it in the following directories (in this order):

+Configuration files

+-------------------

 

-1. ``/home/$user/.config/nimrod.cfg`` (UNIX) or ``%APPDATA%/nimrod.cfg`` (Windows)

-2. ``$nimrod/config/nimrod.cfg`` (UNIX), ``%NIMROD%/config/nimrod.cfg`` (Windows)

-3. ``/etc/nimrod.cfg`` (UNIX)

+**Note:** The *project file name* is the name of the ``.nim`` file that is 

+passed as a command line argument to the compiler.

 

-The search stops as soon as a configuration file has been found. The reading

-of ``nimrod.cfg`` can be suppressed by the ``--skipCfg`` command line option.

+All configuration files have the name ``nimrod.cfg``. The ``nimrod`` 

+executable processes configuration files in the following directories 

+(in this order; later files overwrite previous settings):

 

-**Note:** The *project file name* is the name of the ``.nim`` file that is 

-passed as a command line argument to the compiler. 

+1) ``$nimrod/config/nimrod.cfg``, ``/etc/nimrod.cfg`` (UNIX) or ``%NIMROD%/config/nimrod.cfg`` (Windows). This file can be skipped with the ``--skipCfg`` command line option.

+2) ``/home/$user/.config/nimrod.cfg`` (UNIX) or  ``%APPDATA%/nimrod.cfg`` (Windows). This file can be skipped with the ``--skipUserCfg`` command line option.

+3) ``$parentDir/nimrod.cfg`` where ``$parentDir`` stands for any parent  directory of the project file's path. These files can be skipped with the ``--skipParentCfg`` command line option.

+4) ``$projectDir/nimrod.cfg`` where ``$projectDir`` stands for the project  file's path. This file can be skipped with the ``--skipProjCfg`` command line option.

 

-Configuration settings can be overwritten individually in a project specific

-configuration file that is read automatically. This specific file has to

-be in the same directory as the project and be of the same name, except

-that its extension should be ``.cfg``.

 

 Command line settings have priority over configuration file settings.