config: give a more detailed sample repo config
authorJordi Gutiérrez Hermoso <jordigh@octave.org>
Wed, 08 Oct 2014 07:45:51 -0400
changeset 22836 5a831e4e6d7a
parent 22835 8376d76f77dd
child 22837 2be7d5ebd4d0
config: give a more detailed sample repo config Some examples of the typical configurations that one might want to do in an .hg/hgrc file. This includes a default-push that happens to point to the same location as my-fork. I insist on the myfork terminology for a server-side clone. Bitbucket, Github, and others have widely popularised this meaning of "fork". This also includes a gentle nudge to use a repo-specific username, which is something that people might not instinctively realise is an option.
mercurial/ui.py
--- a/mercurial/ui.py	Tue Oct 07 01:46:53 2014 -0700
+++ b/mercurial/ui.py	Wed Oct 08 07:45:51 2014 -0400
@@ -28,6 +28,18 @@
 
     'local':
 """# example repository config (see "hg help config" for more info)
+[paths]
+# path aliases to other clones of this repo in URLs or filesystem paths
+# (see "hg help config.paths" for more info)
+#
+# default      = http://example.com/hg/example-repo
+# default-push = ssh://jdoe@example.net/hg/jdoes-fork
+# my-fork      = ssh://jdoe@example.net/hg/jdoes-fork
+# my-clone     = /home/jdoe/jdoes-clone
+
+[ui]
+# name and email (local to this repository, optional), e.g.
+# username = Jane Doe <jdoe@example.com>
 """,
 
     'global':