[Python-checkins] devguide (hg_transition): Move the minimal configuration to the committer docs (since it's

[antoine.pitrou]

antoine.pitrou pushed e34f8ae6967e to devguide:

http://hg.python.org/devguide/rev/e34f8ae6967e
changeset:   340:e34f8ae6967e
branch:      hg_transition
tag:         tip
user:        Antoine Pitrou <solipsis at pitrou.net>
date:        Sun Feb 27 19:40:29 2011 +0100
summary:
  Move the minimal configuration to the committer docs (since it's
really necessary there), and expand it to include the eol extension
under Windows

files:
  committing.rst
  setup.rst

diff --git a/committing.rst b/committing.rst
--- a/committing.rst
+++ b/committing.rst
@@ -58,6 +58,44 @@
 .. _collapse: http://mercurial.selenic.com/wiki/CollapseExtension
 
 
+Minimal Configuration
+---------------------
+
+To use Mercurial as a committer (both of your and others' patches), you should
+set up some basic options in your `configuration file`_.  Under Windows,
+TortoiseHg has a graphical settings dialog for most options, meaning you
+don't need to edit the file directly (it is still available in
+``%USERPROFILE%\Mercurial.ini``).  Under other platforms, you must edit
+``~/.hgrc``.
+
+Here are the minimal options you need to activate:
+
+* your *username*: this setting defines the name that will be used when you
+  :ref:`commit <hg-commit>` changes.  The usual convention is to also include
+  an e-mail contact address in there::
+
+   [ui]
+   username = Your Name <email at example.org>
+
+* *extended diffing*: this setting enables an `extended diff format`_
+  which is more useful than the standard unified diff format as it includes
+  metadata about file copies and permission bits::
+
+   [diff]
+   git = on
+
+Under Windows, you should also enable the `eol extension`_, which will
+fix any Windows-specific line endings your text editor might insert when you
+create or modify versioned files.  The public repository has a hook which
+will reject all changesets having the wrong line endings, so enabling this
+extension on your local computer is in your best interest.
+
+
+.. _configuration file: http://www.selenic.com/mercurial/hgrc.5.html#files
+.. _extended diff format: http://www.selenic.com/mercurial/hg.1.html#diffs
+.. _eol extension: http://mercurial.selenic.com/wiki/EolExtension
+
+
 Handling Other's Code
 ---------------------
 
diff --git a/setup.rst b/setup.rst
--- a/setup.rst
+++ b/setup.rst
@@ -21,28 +21,6 @@
 <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