From 5e084ac54ca000f8b72e39579832415e0758341e 2013-10-29 22:37:53 From: Thomas Kluyver Date: 2013-10-29 22:37:53 Subject: [PATCH] Update doc references to .config/ipython --- diff --git a/docs/source/config/overview.rst b/docs/source/config/overview.rst index 6152866..d0dbbbb 100644 --- a/docs/source/config/overview.rst +++ b/docs/source/config/overview.rst @@ -270,21 +270,17 @@ following algorithm: * If not, the value returned by :func:`IPython.utils.path.get_ipython_dir` is used. This function will first look at the :envvar:`IPYTHONDIR` - environment variable and then default to a platform-specific default. + environment variable and then default to :file:`~/.ipython`. Historical support for the :envvar:`IPYTHON_DIR` environment variable will be removed in a future release. -On posix systems (Linux, Unix, etc.), IPython respects the ``$XDG_CONFIG_HOME`` -part of the `XDG Base Directory`_ specification. If ``$XDG_CONFIG_HOME`` is -defined and exists ( ``XDG_CONFIG_HOME`` has a default interpretation of -:file:`$HOME/.config`), then IPython's config directory will be located in -:file:`$XDG_CONFIG_HOME/ipython`. If users still have an IPython directory -in :file:`$HOME/.ipython`, then that will be used. in preference to the -system default. - -For most users, the default value will simply be something like -:file:`$HOME/.config/ipython` on Linux, or :file:`$HOME/.ipython` -elsewhere. +For most users, the configuration directory will be :file:`~/.ipython`. + +Previous versions of IPython on Linux would use the XDG config directory, +creating :file:`~/.config/ipython` by default. We have decided to go +back to :file:`~/.ipython` for consistency among systems. IPython will +issue a warning if it finds the XDG location, and will move it to the new +location if there isn't already a directory there. Once the location of the IPython directory has been determined, you need to know which profile you are using. For users with a single configuration, this will diff --git a/docs/source/interactive/reference.rst b/docs/source/interactive/reference.rst index 9955a67..08db774 100644 --- a/docs/source/interactive/reference.rst +++ b/docs/source/interactive/reference.rst @@ -26,10 +26,10 @@ the command line, simply because they are not practical here. Look into your configuration files for details on those. There are separate configuration files for each profile, and the files look like "ipython_config.py" or "ipython_config_.py". Profile directories look like -"profile_profilename" and are typically installed in the IPYTHONDIR directory. -For Linux users, this will be $HOME/.config/ipython, and for other users it -will be $HOME/.ipython. For Windows users, $HOME resolves to C:\\Documents and -Settings\\YourUserName in most instances. +"profile_profilename" and are typically installed in the IPYTHONDIR directory, +which defaults to :file:`$HOME/.ipython`. For Windows users, :envvar:`HOME` +resolves to :file:`C:\\Documents and Settings\\YourUserName` in most +instances. Eventloop integration diff --git a/docs/source/interactive/tutorial.rst b/docs/source/interactive/tutorial.rst index 4ee52fd..363e48f 100644 --- a/docs/source/interactive/tutorial.rst +++ b/docs/source/interactive/tutorial.rst @@ -181,8 +181,7 @@ Configuration Much of IPython can be tweaked through :ref:`configuration `. To get started, use the command ``ipython profile create`` to produce the default config files. These will be placed in -:file:`~/.ipython/profile_default` or -:file:`~/.config/ipython/profile_default`, and contain comments explaining +:file:`~/.ipython/profile_default`, and contain comments explaining what the various options do. Profiles allow you to use IPython for different tasks, keeping separate config diff --git a/docs/source/parallel/parallel_process.rst b/docs/source/parallel/parallel_process.rst index d908459..1a93609 100644 --- a/docs/source/parallel/parallel_process.rst +++ b/docs/source/parallel/parallel_process.rst @@ -627,7 +627,7 @@ the engines. .. note:: The log output of ipcontroller above shows you where the json files were written. - They will be in :file:`~/.ipython` (or :file:`~/.config/ipython`) under + They will be in :file:`~/.ipython` under :file:`profile_default/security/ipcontroller-engine.json` 3. start the engines, using the connection file:: @@ -644,7 +644,7 @@ A couple of notes: then you need not specify its path directly, only the profile (assumes the path exists, otherwise you must create it first):: - [engine.host.n] $ scp controller.host:.ipython/profile_default/security/ipcontroller-engine.json ~/.config/ipython/profile_ssh/security/ + [engine.host.n] $ scp controller.host:.ipython/profile_default/security/ipcontroller-engine.json ~/.ipython/profile_ssh/security/ [engine.host.n] $ ipengine --profile=ssh Of course, if you fetch the file into the default profile, no arguments must be passed to