Mercurial > hg
changeset 22586:6e5657ce9e8c
help: use OS containers for config file lists
author | Matt Mackall <mpm@selenic.com> |
---|---|
date | Tue, 30 Sep 2014 15:55:30 -0500 |
parents | 15282c6612fb |
children | c3c3dd31fe1c |
files | mercurial/help/config.txt |
diffstat | 1 files changed, 64 insertions(+), 52 deletions(-) [+] |
line wrap: on
line diff
--- a/mercurial/help/config.txt Tue Sep 30 15:51:22 2014 -0500 +++ b/mercurial/help/config.txt Tue Sep 30 15:55:30 2014 -0500 @@ -28,68 +28,80 @@ paths are given below, settings from earlier paths override later ones. -| (All) ``<repo>/.hg/hgrc`` +.. container:: verbose.unix - Per-repository configuration options that only apply in a - particular repository. This file is not version-controlled, and - will not get transferred during a "clone" operation. Options in - this file override options in all other configuration files. On - Plan 9 and Unix, most of this file will be ignored if it doesn't - belong to a trusted user or to a trusted group. See the documentation - for the ``[trusted]`` section below for more details. + On Unix, the following files are consulted: -| (Plan 9) ``$home/lib/hgrc`` -| (Unix) ``$HOME/.hgrc`` -| (Windows) ``%USERPROFILE%\.hgrc`` -| (Windows) ``%USERPROFILE%\Mercurial.ini`` -| (Windows) ``%HOME%\.hgrc`` -| (Windows) ``%HOME%\Mercurial.ini`` + - ``<repo>/.hg/hgrc`` (per-repository) + - ``$HOME/.hgrc`` (per-user) + - ``<install-root>/etc/mercurial/hgrc`` (per-installation) + - ``<install-root>/etc/mercurial/hgrc.d/*.rc`` (per-installation) + - ``/etc/mercurial/hgrc`` (per-system) + - ``/etc/mercurial/hgrc.d/*.rc`` (per-system) - Per-user configuration file(s), for the user running Mercurial. On - Windows 9x, ``%HOME%`` is replaced by ``%APPDATA%``. Options in these - files apply to all Mercurial commands executed by this user in any - directory. Options in these files override per-system and per-installation - options. - -| (Plan 9) ``/lib/mercurial/hgrc`` -| (Plan 9) ``/lib/mercurial/hgrc.d/*.rc`` -| (Unix) ``/etc/mercurial/hgrc`` -| (Unix) ``/etc/mercurial/hgrc.d/*.rc`` +.. container:: verbose.windows - Per-system configuration files, for the system on which Mercurial - is running. Options in these files apply to all Mercurial commands - executed by any user in any directory. Options in these files - override per-installation options. - -| (Plan 9) ``<install-root>/lib/mercurial/hgrc`` -| (Plan 9) ``<install-root>/lib/mercurial/hgrc.d/*.rc`` -| (Unix) ``<install-root>/etc/mercurial/hgrc`` -| (Unix) ``<install-root>/etc/mercurial/hgrc.d/*.rc`` + On Windows, the following files are consulted: - Per-installation configuration files, searched for in the - directory where Mercurial is installed. ``<install-root>`` is the - parent directory of the **hg** executable (or symlink) being run. For - example, if installed in ``/shared/tools/bin/hg``, Mercurial will look - in ``/shared/tools/etc/mercurial/hgrc``. Options in these files apply - to all Mercurial commands executed by any user in any directory. + - ``<repo>/.hg/hgrc`` (per-repository) + - ``%USERPROFILE%\.hgrc`` (per-user) + - ``%USERPROFILE%\Mercurial.ini`` (per-user) + - ``%HOME%\.hgrc`` (per-user) + - ``%HOME%\Mercurial.ini`` (per-user) + - ``<install-dir>\Mercurial.ini`` (per-installation) + - ``<install-dir>\hgrc.d\*.rc`` (per-installation) + - ``HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial`` (per-installation) -| (Windows) ``<install-dir>\Mercurial.ini`` **or** -| (Windows) ``<install-dir>\hgrc.d\*.rc`` **or** -| (Windows) ``HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial`` - - Per-installation/system configuration files, for the system on - which Mercurial is running. Options in these files apply to all - Mercurial commands executed by any user in any directory. Registry - keys contain PATH-like strings, every part of which must reference - a ``Mercurial.ini`` file or be a directory where ``*.rc`` files will - be read. Mercurial checks each of these locations in the specified - order until one or more configuration files are detected. - -.. note:: + .. note:: The registry key ``HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Mercurial`` is used when running 32-bit Python on 64-bit Windows. +.. container:: verbose.plan9 + + On Plan9, the following files are consulted: + + - ``<repo>/.hg/hgrc`` (per-repository) + - ``$home/lib/hgrc`` (per-user) + - ``<install-root>/lib/mercurial/hgrc`` (per-installation) + - ``<install-root>/lib/mercurial/hgrc.d/*.rc`` (per-installation) + - ``/lib/mercurial/hgrc`` (per-system) + - ``/lib/mercurial/hgrc.d/*.rc`` (per-system) + +Per-repository configuration options only apply in a +particular repository. This file is not version-controlled, and +will not get transferred during a "clone" operation. Options in +this file override options in all other configuration files. On +Plan 9 and Unix, most of this file will be ignored if it doesn't +belong to a trusted user or to a trusted group. See the documentation +for the ``[trusted]`` section below for more details. + +Per-user configuration file(s) are for the user running Mercurial. On +Windows 9x, ``%HOME%`` is replaced by ``%APPDATA%``. Options in these +files apply to all Mercurial commands executed by this user in any +directory. Options in these files override per-system and per-installation +options. + +Per-installation configuration files are searched for in the +directory where Mercurial is installed. ``<install-root>`` is the +parent directory of the **hg** executable (or symlink) being run. For +example, if installed in ``/shared/tools/bin/hg``, Mercurial will look +in ``/shared/tools/etc/mercurial/hgrc``. Options in these files apply +to all Mercurial commands executed by any user in any directory. + +Per-installation configuration files are for the system on +which Mercurial is running. Options in these files apply to all +Mercurial commands executed by any user in any directory. Registry +keys contain PATH-like strings, every part of which must reference +a ``Mercurial.ini`` file or be a directory where ``*.rc`` files will +be read. Mercurial checks each of these locations in the specified +order until one or more configuration files are detected. + +Per-system configuration files are for the system on which Mercurial +is running. Options in these files apply to all Mercurial commands +executed by any user in any directory. Options in these files +override per-installation options. + Syntax ======