doc that ReadFile reads in text mode on Windows
authorEvan Martin <martine@danga.com>
Sun, 12 Aug 2012 18:59:35 +0000 (11:59 -0700)
committerEvan Martin <martine@danga.com>
Sun, 12 Aug 2012 18:59:35 +0000 (11:59 -0700)
src/util.h

index ab1882b..7e30368 100644 (file)
@@ -41,7 +41,8 @@ bool CanonicalizePath(string* path, string* err);
 
 bool CanonicalizePath(char* path, size_t* len, string* err);
 
-/// Read a file to a string.
+/// Read a file to a string (in text mode: with CRLF conversion
+/// on Windows).
 /// Returns -errno and fills in \a err on error.
 int ReadFile(const string& path, string* contents, string* err);