Merge pull request #208 from lpefferkorn/readfile_notes

Adding notes to readfile(), subsequently to internal code update
cfengine · Oct 29, 2013 · 1d46a6f · 1d46a6f
2 parents a95884c + 2dbf9f8
commit 1d46a6f
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/reference/functions/readfile.markdown b/reference/functions/readfile.markdown
@@ -22,3 +22,9 @@ tags: [reference, io functions, functions, readfile]
         string => readfile( "/home/mark/tmp/testfile" , "33" );
 ```
 
+**Notes:**
+- At the moment, only the first 4096 bytes of the file can be retrieved.
+- To reliably read files located within /proc or /sys directories,
+`maxsize` has to be set to `0`.
+
+**History:** 4096 bytes limit and special `0` value were introduced in 3.6.0