changeset 46039:b9ebe0bfed4e

scmutil: document that bookmarkrevs() ignores non-head bookmark branch "- ancestors(head() and not bookmark(%s))" excludes the bookmarked branch itself if bookmark(%s) is not a head. I'm a bit surprised by this behavior while writing "log -B" tests, so let's document it.
author Yuya Nishihara <yuya@tcha.org>
date Tue, 01 Dec 2020 19:46:01 +0900
parents 8dca9051a859
children 9ee791f3278f
files mercurial/scmutil.py
diffstat 1 files changed, 3 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/mercurial/scmutil.py	Sat Nov 07 16:28:30 2020 -0800
+++ b/mercurial/scmutil.py	Tue Dec 01 19:46:01 2020 +0900
@@ -2300,8 +2300,9 @@
 
 
 def bookmarkrevs(repo, mark):
-    """
-    Select revisions reachable by a given bookmark
+    """Select revisions reachable by a given bookmark
+
+    If the bookmarked revision isn't a head, an empty set will be returned.
     """
     return repo.revs(
         b"ancestors(bookmark(%s)) - "