changeset 16799:aac60c9bfc77

add Jordi's tips on hg extensions to the manual contrib.txi(Basics of Generating a Changeset): add the tips from mailing list
author Torsten <ttl@justmail.de>
date Fri, 21 Jun 2013 20:50:55 +0200
parents 519343308ab1
children d749c9b588e5
files doc/interpreter/contrib.txi
diffstat 1 files changed, 59 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/doc/interpreter/contrib.txi
+++ b/doc/interpreter/contrib.txi
@@ -89,7 +89,16 @@
 @end example
 
 You may want to get familiar with Mercurial queues to manage your
-changesets.  Here is a slightly more complex example using Mercurial
+changesets. For working with queues you have to activate the extension
+mq with the following entry in Mercurials config file @file{.hgrc} (or
+@file{Mercurial.ini} on Windows):
+
+@example
+[extensions]
+mq=
+@end example
+
+Here is a slightly more complex example using Mercurial
 queues, where work on two unrelated changesets is done in parallel and
 one of the changesets is updated after discussion on the bug tracker:
 
@@ -122,6 +131,55 @@
 # attach ../nasty2.diff to your bug report
 @end example
 
+Mercurial has a more useful extensions that really should be enabled.
+They are not enabled by default due to a number of factors
+(mostly because they don't work in all terminal types).
+
+The following entries in the @file{.hgrc} are recommended
+
+@example
+[extensions]
+graphlog=
+color=
+progress=
+pager=
+@end example
+
+For the colour extension, default colour and formatting
+of @code{hg status} can be modified by
+
+@example
+[color]
+status.modified = magenta bold
+status.added = green bold
+status.removed = red bold
+status.deleted = cyan bold
+status.unknown = black  bold
+status.ignored = black bold
+@end example
+
+Sometimes a few further improvements for the pager extension are
+necessary. The following options should not be enabled unless paging
+isn't working correctly:
+
+@example
+[pager]
+# Some options for the less pager, see less(1) for their meaning.
+pager = LESS='FSRX' less
+
+# Some commands that aren't paged by default; also enable paging
+# for them
+attend = tags, help, annotate, cat, diff, export, status, \
+         outgoing, incoming
+@end example
+
+Enabling the described extensions should immediately lead to a difference
+when using the command line version of hg. Of these options, the only one
+that enables a new command is graphlog. It is recommanded that you use the
+command @code{hg glog} instead of @code{hg log} for a better feel
+what commits are being based on.
+
+
 @node General Guidelines
 @section General Guidelines