# HG changeset patch
# User Adrian Buehlmann <adrian@cadifra.com>
# Date 1347738113 -7200
# Node ID e9af2134825c468269ed5f22af001dd58ec1d6cd
# Parent  88244af1f66e7c41b3e4bc7cd97d3898fe594b85
store: explain "aux.foo" versus "foo.aux" in doc of _auxencode()

diff -r 88244af1f66e -r e9af2134825c mercurial/store.py
--- a/mercurial/store.py	Sat Sep 15 21:41:45 2012 +0200
+++ b/mercurial/store.py	Sat Sep 15 21:41:53 2012 +0200
@@ -127,8 +127,10 @@
     period or space. Does not touch other single reserved characters c.
     Specifically, c in '\\:*?"<>|' or ord(c) <= 31 are *not* encoded here.
     Additionally encodes space or period at the beginning, if dotencode is
-    True.
-    path is assumed to be all lowercase.
+    True. Parameter path is assumed to be all lowercase.
+    A segment only needs encoding if a reserved name appears as a
+    basename (e.g. "aux", "aux.foo"). A directory or file named "foo.aux"
+    doesn't need encoding.
 
     >>> _auxencode('.foo/aux.txt/txt.aux/con/prn/nul/foo.', True)
     '~2efoo/au~78.txt/txt.aux/co~6e/pr~6e/nu~6c/foo~2e'