# HG changeset patch
# User Yuya Nishihara <yuya@tcha.org>
# Date 1606819561 -32400
# Node ID b9ebe0bfed4e619c63e2fbb826aa73e8e0af820e
# Parent  8dca9051a8592e5c001feb0069b2bc70d93441a9
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.

diff -r 8dca9051a859 -r b9ebe0bfed4e mercurial/scmutil.py
--- 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)) - "