Rev 3335: Document that only LockDir invokes physical lock hooks. in http://people.ubuntu.com/~robertc/baz2.0/physicallock.hooks

[Robert Collins]

At http://people.ubuntu.com/~robertc/baz2.0/physicallock.hooks

------------------------------------------------------------
revno: 3335
revision-id: robertc at robertcollins.net-20080407205752-lfpd9ofybi31oia9
parent: robertc at robertcollins.net-20080407205527-v85go5c4dc8cwe04
committer: Robert Collins <robertc at robertcollins.net>
branch nick: PhysicalLock.hooks
timestamp: Tue 2008-04-08 06:57:52 +1000
message:
  Document that only LockDir invokes physical lock hooks.
modified:
  bzrlib/lock.py                 lock.py-20050527050856-ec090bb51bc03349
=== modified file 'bzrlib/lock.py'
--- a/bzrlib/lock.py	2008-04-07 20:55:27 +0000
+++ b/bzrlib/lock.py	2008-04-07 20:57:52 +0000
@@ -46,7 +46,11 @@
 
 
 class PhysicalLockHooks(Hooks):
-    """hooks for physical lock activity."""
+    """Hooks for physical lock activity.
+    
+    Note that LockDir is the only physical lock that is known to trigger these
+    hooks today.
+    """
 
     def __init__(self):
         """Create the default hooks.