Patchwork [2,of,3,STABLE] help: add definition of "active" to bookmarks help and glossary (issue4244)

login
register
mail settings
Submitter Kevin Bullock
Date June 10, 2014, 1:59 a.m.
Message ID <703653e802dee14d6609.1402365554@billings.hsd1.mn.comcast.net>
Download mbox | patch
Permalink /patch/4958/
State Superseded
Headers show

Comments

Kevin Bullock - June 10, 2014, 1:59 a.m.
# HG changeset patch
# User Kevin Bullock <kbullock@ringworld.org>
# Date 1402362397 18000
#      Mon Jun 09 20:06:37 2014 -0500
# Branch stable
# Node ID 703653e802dee14d66090659c11bc32b9675a8a3
# Parent  d42fb8228f53f963bab6b011c3ed9624a14c62f8
help: add definition of "active" to bookmarks help and glossary (issue4244)

Patch

diff --git a/mercurial/commands.py b/mercurial/commands.py
--- a/mercurial/commands.py
+++ b/mercurial/commands.py
@@ -806,6 +806,10 @@  def bookmark(ui, repo, *names, **opts):
     a revision using -r REV (where REV may be an existing bookmark),
     the bookmark is assigned to that revision.
 
+    When you set a new bookmark or check out an existing bookmark by
+    name, that bookmark becomes 'active'. Any commits you make will move
+    the bookmark forward.
+
     Bookmarks can be pushed and pulled between repositories (see :hg:`help
     push` and :hg:`help pull`). This requires both the local and remote
     repositories to support bookmarks. For versions prior to 1.8, this means
diff --git a/mercurial/help/glossary.txt b/mercurial/help/glossary.txt
--- a/mercurial/help/glossary.txt
+++ b/mercurial/help/glossary.txt
@@ -18,6 +18,11 @@  Bookmark
     :hg:`help update`). Pushing and pulling bookmarks allow you to
     collaborate with others on a branch without creating a named branch.
 
+Bookmark, active
+    When a bookmark is checked out by name, it becomes the active
+    bookmark. Any commits made to the repository will move that bookmark
+    forward.
+
 Branch
     (Noun) A child changeset that has been created from a parent that
     is not a head. These are known as topological branches, see