Mercurial > hg

changeset 27185:d52765831086

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
bookmarks: document getbkfile method I'm working on bmstore again, and this function gave me a moment's pause. Document it to save future readers from any undue confusion.
author Augie Fackler <augie@google.com>
date Wed, 11 Nov 2015 20:43:25 -0500
parents 64187e9a5659
children 34d26e22a2b0
files mercurial/bookmarks.py
diffstat 1 files changed, 6 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/mercurial/bookmarks.py	Sat Oct 31 22:50:03 2015 +0900
+++ b/mercurial/bookmarks.py	Wed Nov 11 20:43:25 2015 -0500
@@ -61,6 +61,12 @@
                 raise
 
     def getbkfile(self, repo):
+        """Hook so that extensions that mess with the store can hook bm storage.
+
+        For core, this just handles wether we should see pending
+        bookmarks or the committed ones. Other extensions (like share)
+        may need to tweak this behavior further.
+        """
         bkfile = None
         if 'HG_PENDING' in os.environ:
             try: