help config: explain that config files do not exist by default stable
authorMartin Geisler <mg@lazybytes.net>
Mon, 18 Apr 2011 13:57:22 +0200
branchstable
changeset 13955 86b5cc1e8be8
parent 13952 1416b9118540
child 13957 044e1356327d
help config: explain that config files do not exist by default Inspired by critique given on StackOverflow where a user writes: I can have a good guess at what "%USERPROFILE%" might signify but none of the files listed in the "hg help config" output exist after running the installer. Previous experience would suggest that missing files mean something somewhere has gone seriously wrong. http://stackoverflow.com/questions/2329023/2351139#2351139
mercurial/help/config.txt
--- a/mercurial/help/config.txt	Tue Apr 19 00:41:47 2011 +0300
+++ b/mercurial/help/config.txt	Mon Apr 18 13:57:22 2011 +0200
@@ -22,6 +22,12 @@
 - ``<install-root>/etc/mercurial/hgrc``
 - ``<install-root>/etc/mercurial/hgrc.d/*.rc``
 
+These files do not exist by default and you will have to create the
+appropriate configuration files yourself: global configuration like
+the username setting is typically put into
+``%USERPROFILE%\mercurial.ini`` or ``$HOME/.hgrc`` and local
+configuration is put into the per-repository ``<repo>/.hg/hgrc`` file.
+
 If there is a per-repository configuration file which is not owned by
 the active user, Mercurial will warn you that the file is skipped::