[PATCH 1 of 1] bookmarks: improve help
Cédric Duval
cedricduval at free.fr
Fri Jun 19 01:25:07 CDT 2009
# HG changeset patch
# User Cédric Duval <cedricduval at free.fr>
# Date 1245390504 -7200
# Node ID 5904ed1186a7e6eaa0b35c13ba8a60d1e0f9b784
# Parent ce4b92f5cea7871ee2135c19843a6fc7af3d6136
bookmarks: improve help
- more meaningful headline
- bookmarks are obviously Mercurial's, no need to specify that
- more explicit about the behavior without track.current
- typos
diff --git a/hgext/bookmarks.py b/hgext/bookmarks.py
--- a/hgext/bookmarks.py
+++ b/hgext/bookmarks.py
@@ -5,24 +5,26 @@
# This software may be used and distributed according to the terms of the
# GNU General Public License version 2, incorporated herein by reference.
-'''Mercurial bookmarks
+'''track a line of development with moving markers
-Mercurial bookmarks are local moveable pointers to changesets. Every
-bookmark points to a changeset identified by its hash. If you commit a
+Bookmarks are local moveable pointers to changesets. Every bookmark
+points to a changeset identified by its hash. If you commit a
changeset that is based on a changeset that has a bookmark on it, the
bookmark is forwarded to the new changeset.
It is possible to use bookmark names in every revision lookup (e.g. hg
merge, hg update).
-The bookmark extension offers the possiblity to have a more git-like
-experience by adding the following configuration option to your .hgrc:
+By default, when several bookmarks point to the same changeset, they
+will all move forward together. It is possible to obtain a more
+git-like experience by adding the following configuration option to
+your .hgrc:
-[bookmarks]
-track.current = True
+ [bookmarks]
+ track.current = True
-This will cause bookmarks to track the bookmark that you are currently
-on, and just updates it. This is similar to git's approach to
+This will cause Mercurial to track the bookmark that you are currently
+on, and just update it. This is similar to git's approach to
branching.
'''
@@ -112,7 +114,7 @@
repo._bookmarkcurrent = mark
def bookmark(ui, repo, mark=None, rev=None, force=False, delete=False, rename=None):
- '''Mercurial bookmarks
+ '''track a line of development with moving markers
Bookmarks are pointers to certain commits that move when
commiting. Bookmarks are local. They can be renamed, copied and
More information about the Mercurial-devel
mailing list