From bcc45d55c5c2b790fc335da2922d8a7c61236e86 2016-05-25 21:03:08 From: Matthias Bussonnier Date: 2016-05-25 21:03:08 Subject: [PATCH] Document IPYTHON_SUPPRESS_CONFIG_ERRORS. Closes #9493 --- diff --git a/docs/source/development/config.rst b/docs/source/development/config.rst index 39ec35c..08bdb41 100644 --- a/docs/source/development/config.rst +++ b/docs/source/development/config.rst @@ -55,6 +55,17 @@ under :file:`profile_default`. If you want the default config files for the :mod:`IPython.parallel` applications, add ``--parallel`` to the end of the command-line args. +.. note:: + + By default IPython will ignore any invalid configuration files, or any + unknown configuration option. + +.. versionadded:: 5.0 + + IPython can be configured to abort in case of invalid configuration file. + To do so set the environment variable ``IPYTHON_SUPPRESS_CONFIG_ERRORS`` to + `'1'` or `'true'` + Locating these files --------------------