mercurial/util.py
branchstable
changeset 51649 ba205f944cb4
parent 51620 59f846fbc11d
child 51677 522b4d729e89
--- a/mercurial/util.py	Mon Jun 24 13:14:05 2024 +0200
+++ b/mercurial/util.py	Wed Jul 03 12:22:48 2024 +0200
@@ -441,6 +441,13 @@
 
 
 def mmapread(fp, size=None):
+    """Read a file content using mmap
+
+    The responsability of checking the file system is mmap safe is the
+    responsability of the caller.
+
+    In some case, a normal string might be returned.
+    """
     if size == 0:
         # size of 0 to mmap.mmap() means "all data"
         # rather than "zero bytes", so special case that.