Mercurial > public > mercurial-scm > hg
diff mercurial/bookmarks.py @ 24945:e0b0fbd47491
bookmarks: rename setcurrent to activate (API)
Today, the terms 'active' and 'current' are interchangeably used throughout the
codebase in reference to the active bookmark (the bookmark that will be updated
with the next commit). This leads to confusion among developers and users.
This patch is part of a series to standardize the usage to 'active' throughout
the mercurial codebase and user interface.
| author | Ryan McElroy <rmcelroy@fb.com> |
|---|---|
| date | Mon, 13 Apr 2015 22:27:01 -0700 |
| parents | 08ec11e3ae4c |
| children | c44534209a0a |
line wrap: on
line diff
--- a/mercurial/bookmarks.py Mon Apr 13 21:53:37 2015 -0700 +++ b/mercurial/bookmarks.py Mon Apr 13 22:27:01 2015 -0700 @@ -129,12 +129,12 @@ file.close() return mark -def setcurrent(repo, mark): - '''Set the name of the bookmark that we are currently on - - Set the name of the bookmark that we are on (hg update <bookmark>). +def activate(repo, mark): + """ + Set the given bookmark to be 'active', meaning that this bookmark will + follow new commits that are made. The name is recorded in .hg/bookmarks.current - ''' + """ if mark not in repo._bookmarks: raise AssertionError('bookmark %s does not exist!' % mark)