[Python-checkins] devguide (hg_transition): Add section about minimal Mercurial configuration

[eric.araujo]

eric.araujo pushed 0a4b6a217350 to devguide:

http://hg.python.org/devguide/rev/0a4b6a217350
changeset:   333:0a4b6a217350
branch:      hg_transition
user:        ?ric Araujo <merwok at netwok.org>
date:        Sat Feb 26 18:50:44 2011 +0100
summary:
  Add section about minimal Mercurial configuration

files:
  setup.rst

diff --git a/setup.rst b/setup.rst
--- a/setup.rst
+++ b/setup.rst
@@ -21,6 +21,28 @@
 <http://tortoisehg.org/>`_ graphical client.
 
 
+Minimal Configuration
+'''''''''''''''''''''
+
+To use ``hg`` on the command line, you should set up some basic options in
+your `configuration file`_ (``~/.hgrc`` on POSIX,
+``%USERPROFILE%\Mercurial.ini`` on Windows). ::
+
+   [ui]
+   username = Your Name <email at example.org>
+
+   [diff]
+   git = on
+
+The first setting defines the name that will be used when you :ref:`commit
+<hg-commit>` changes. The second setting enables an `extended diff format`_
+which is more useful than the standard unified diff format.
+
+Note that TortoiseHg has a graphical settings dialog.
+
+.. _configuration file: http://www.selenic.com/mercurial/hgrc.5.html#files
+.. _extended diff format: http://www.selenic.com/mercurial/hg.1.html#diffs
+
 .. _checkout:
 
 Getting the Source Code

--
Repository URL: http://hg.python.org/devguide