Mercurial > hg

changeset 9785:b52f0f221325

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
help: add "hg help config" topic This is a condensed version of the first two sections of hgrc.5.txt. After a slight upgrade of minirst, we can move the whole of hgrc.5.txt into the config help topic and just let the man page include it.
author Martin Geisler <mg@lazybytes.net>
date Sat, 07 Nov 2009 22:12:50 +0100
parents 54d292da1df7
children 951730b2b8ba
files help/config.txt mercurial/help.py tests/test-globalopts.out tests/test-help.out
diffstat 4 files changed, 42 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/help/config.txt	Sat Nov 07 22:12:50 2009 +0100
@@ -0,0 +1,37 @@
+Mercurial reads configuration data from several files, if they exist.
+Below we list the most specific file first.
+
+On Windows, these configuration files are read:
+
+- ``<repo>\.hg\hgrc``
+- ``%USERPROFILE%\.hgrc``
+- ``%USERPROFILE%\Mercurial.ini``
+- ``%HOME%\.hgrc``
+- ``%HOME%\Mercurial.ini``
+- ``C:\Mercurial\Mercurial.ini``
+- ``HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial``
+- ``<install-dir>\Mercurial.ini``
+
+On Unix, these files are read:
+
+- ``<repo>/.hg/hgrc``
+- ``$HOME/.hgrc``
+- ``/etc/mercurial/hgrc``
+- ``/etc/mercurial/hgrc.d/*.rc``
+- ``<install-root>/etc/mercurial/hgrc``
+- ``<install-root>/etc/mercurial/hgrc.d/*.rc``
+
+The configuration files for Mercurial use a simple ini-file format. A
+configuration file consists of sections, led by a ``[section]`` header
+and followed by ``name = value`` entries::
+
+  [ui]
+  username = Firstname Lastname <firstname.lastname@example.net>
+  verbose = True
+
+This above entries will be referred to as ``ui.username`` and
+``ui.verbose``, respectively. Please see the hgrc man page for a full
+description of the possible configuration values:
+
+- on Unix-like systems: ``man hgrc``
+- online: http://www.selenic.com/mercurial/hgrc.5.html
--- a/mercurial/help.py	Sat Nov 07 18:47:04 2009 +0100
+++ b/mercurial/help.py	Sat Nov 07 22:12:50 2009 +0100
@@ -80,6 +80,7 @@
     return loader
 
 helptable = (
+    (["config"], _("Configuration Files"), loaddoc('config')),
     (["dates"], _("Date Formats"), loaddoc('dates')),
     (["patterns"], _("File Name Patterns"), loaddoc('patterns')),
     (['environment', 'env'], _('Environment Variables'), loaddoc('environment')),
--- a/tests/test-globalopts.out	Sat Nov 07 18:47:04 2009 +0100
+++ b/tests/test-globalopts.out	Sat Nov 07 22:12:50 2009 +0100
@@ -202,6 +202,7 @@
 
 additional help topics:
 
+ config       Configuration Files
  dates        Date Formats
  patterns     File Name Patterns
  environment  Environment Variables
@@ -270,6 +271,7 @@
 
 additional help topics:
 
+ config       Configuration Files
  dates        Date Formats
  patterns     File Name Patterns
  environment  Environment Variables
--- a/tests/test-help.out	Sat Nov 07 18:47:04 2009 +0100
+++ b/tests/test-help.out	Sat Nov 07 22:12:50 2009 +0100
@@ -95,6 +95,7 @@
 
 additional help topics:
 
+ config       Configuration Files
  dates        Date Formats
  patterns     File Name Patterns
  environment  Environment Variables
@@ -159,6 +160,7 @@
 
 additional help topics:
 
+ config       Configuration Files
  dates        Date Formats
  patterns     File Name Patterns
  environment  Environment Variables