Fix lockfile() docstring to correctly document the wantnewlockfile behavior.

Thanks to Arfrever for reporting. (trunk r13355)

svn path=/main/branches/2.1.6/; revision=13511

diff --git a/pym/portage/locks.py b/pym/portage/locks.py
index 05a65644fe806b04f46ecd22c03e32372321c598..c256a5ada36ef780dbc9a4a7094ea5cf25f69526 100644 (file)
--- a/pym/portage/locks.py
+++ b/pym/portage/locks.py
@@ -28,8 +28,10 @@ def unlockdir(mylock):
 
 def lockfile(mypath, wantnewlockfile=0, unlinkfile=0,
        waiting_msg=None, flags=0):
-       """Creates all dirs upto, the given dir. Creates a lockfile
-       for the given directory as the file: directoryname+'.portage_lockfile'."""
+       """
+       If wantnewlockfile is True then this creates a lockfile in the parent
+       directory as the file: '.' + basename + '.portage_lockfile'.
+       """
        import fcntl
 
        if not mypath: