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.
This commit is contained in:
Martin Geisler 2009-11-07 22:12:50 +01:00
parent a734140a12
commit d9281d88ed
4 changed files with 42 additions and 0 deletions

37
help/config.txt Normal file
View File

@ -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

View File

@ -80,6 +80,7 @@ def loaddoc(topic):
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')),

View File

@ -202,6 +202,7 @@ list of commands:
additional help topics:
config Configuration Files
dates Date Formats
patterns File Name Patterns
environment Environment Variables
@ -270,6 +271,7 @@ list of commands:
additional help topics:
config Configuration Files
dates Date Formats
patterns File Name Patterns
environment Environment Variables

View File

@ -95,6 +95,7 @@ list of commands:
additional help topics:
config Configuration Files
dates Date Formats
patterns File Name Patterns
environment Environment Variables
@ -159,6 +160,7 @@ use "hg -v help" to show aliases and global options
additional help topics:
config Configuration Files
dates Date Formats
patterns File Name Patterns
environment Environment Variables