[PATCH] clarify hg-git's behavior regarding bookmarks/named branches

[Mike Bayer]

# HG changeset patch
# User Mike Bayer <mik...@zzzcomputing.com>
# Date 1330204382 18000
# Node ID dfd14c8cd58461029246dcfdcce77f2b5da50359
# Parent 56c8860d730374d90f5c2a6e639f84a5da4e59bb
clarify hg-git's behavior regarding bookmarks/named branches

diff -r 56c8860d7303 -r dfd14c8cd584 README.md
--- a/README.md Thu Feb 23 13:49:07 2012 -0500
+++ b/README.md Sat Feb 25 16:13:02 2012 -0500
@@ -183,16 +183,18 @@
git.branch_bookmark_suffix
---------------------------

-hg-git currently does not recognize Mercurial named branches; it only supports Mercurial
-bookmarks. Therefore, when translating an hg repo over to git, you typically need
-to create bookmarks to mirror all the named branches that you'd like to see transferred
-over to git. The major caveat with this is that you can't use the same name for your
-bookmark as that of the named branch, and furthermore there's no feasible way to rename
-a branch in Mercurial. For the use case where one would like to transfer an hg
-repo over to git, and maintain the same named branches as are present on the hg side,
-the `branch_bookmark_suffix` might be all that's needed. This presents a string
-"suffix" that will be recognized on each bookmark name, and stripped off as the
-bookmark is translated to a git branch:
+hg-git does not convert between Mercurial named branches and git branches as
+the two are conceptually different; instead, it uses Mercurial bookmarks to
+represent the concept of a git branch. Therefore, when translating an hg repo
+over to git, you typically need to create bookmarks to mirror all the named
+branches that you'd like to see transferred over to git. The major caveat with
+this is that you can't use the same name for your bookmark as that of the
+named branch, and furthermore there's no feasible way to rename a branch in
+Mercurial. For the use case where one would like to transfer an hg repo over
+to git, and maintain the same named branches as are present on the hg side,
+the `branch_bookmark_suffix` might be all that's needed. This presents a
+string "suffix" that will be recognized on each bookmark name, and stripped
+off as the bookmark is translated to a git branch:

[git]
branch_bookmark_suffix=_bookmark

[Augie Fackler]

Please resend the whole series, including the two you already mailed