Added documentation.

abdc5138 · Aaron Jacobs · 0c77f49e · abdc5138
Commit abdc5138 authored May 18, 2015 by Aaron Jacobs
Hide whitespace changes
Inline Side-by-side

Showing with 3 additions and 1 deletion

mounted_file_system.go mounted_file_system.go +3 -1

No files found.
--- a/mounted_file_system.go
+++ b/mounted_file_system.go
@@ -65,7 +65,9 @@ type MountConfig struct {
 	// should inherit. If nil, context.Background() will be used.
 	OpContext context.Context

-	// TODO(jacobsa): Add comments.
+	// Mount the file system in read-only mode. File modes will appear as normal,
+	// but opening a file for writing and metadata operations like chmod,
+	// chtimes, etc. will fail.
 	ReadOnly bool

 	// OS X only.