summary refs log tree commit diff stats
path: root/doc/nimc.rst
diff options
context:
space:
mode:
authordemotomohiro <gpuppur@gmail.com>2018-09-29 02:37:14 +0900
committerdemotomohiro <gpuppur@gmail.com>2018-09-29 02:37:14 +0900
commit119d76d80e009ce559a5daa2e7214789fcac2879 (patch)
tree48beef5447036a5303934599946548f9152af395 /doc/nimc.rst
parent99a874cc8af70db58da0f3e5e00c318488c6c3ea (diff)
downloadNim-119d76d80e009ce559a5daa2e7214789fcac2879.tar.gz
Nim Compiler User Guide: Fix how user config file is searched
Diffstat (limited to 'doc/nimc.rst')
-rw-r--r--doc/nimc.rst2
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/nimc.rst b/doc/nimc.rst
index 4082b5378..9fa181f48 100644
--- a/doc/nimc.rst
+++ b/doc/nimc.rst
@@ -158,7 +158,7 @@ The ``nim`` executable processes configuration files in the following
 directories (in this order; later files overwrite previous settings):
 
 1) ``$nim/config/nim.cfg``, ``/etc/nim/nim.cfg`` (UNIX) or ``%NIM%/config/nim.cfg`` (Windows). This file can be skipped with the ``--skipCfg`` command line option.
-2) ``$HOME/.config/nim.cfg`` (POSIX) or  ``%APPDATA%/nim.cfg`` (Windows). This file can be skipped with the ``--skipUserCfg`` command line option.
+2) If environment variable ``XDG_CONFIG_HOME`` is defined, ``$XDG_CONFIG_HOME/nim/nim.cfg`` or ``~/.config/nim/nim.cfg`` (POSIX) or ``%APPDATA%/nim/nim.cfg`` (Windows). This file can be skipped with the ``--skipUserCfg`` command line option.
 3) ``$parentDir/nim.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/nim.cfg`` where ``$projectDir`` stands for the project  file's path. This file can be skipped with the ``--skipProjCfg`` command line option.
 5) A project can also have a project specific configuration file named ``$project.nim.cfg`` that resides in the same directory as ``$project.nim``. This file can be skipped with the ``--skipProjCfg`` command line option.