# HG changeset patch
# User Siddharth Agarwal <sid0@fb.com>
# Date 2015-10-05 02:28:43
# Node ID 406a654b41cb598f4b26ddb67d121314817c5829
# Parent  41dd7b2c7e15edf96e4c5ae99f72e75ba36838e4

localrepo: add a note about parentenvvar

Review feedback from Pierre-Yves David.

diff --git a/mercurial/localrepo.py b/mercurial/localrepo.py
--- a/mercurial/localrepo.py
+++ b/mercurial/localrepo.py
@@ -1214,6 +1214,8 @@ class localrepository(object):
     def _lock(self, vfs, lockname, wait, releasefn, acquirefn, desc,
               parentenvvar=None):
         parentlock = None
+        # the contents of parentenvvar are used by the underlying lock to
+        # determine whether it can be inherited
         if parentenvvar is not None:
             parentlock = os.environ.get(parentenvvar)
         try: