fileio: add brief explanations for flags

diff --git a/src/basic/fileio.h b/src/basic/fileio.h
index 0b88fdfdcb5763533b6e3832f420238967c2f110..7d58fa7cfc24d51033edb97a3f7a4fec6d6aa5f1 100644 (file)
--- a/src/basic/fileio.h
+++ b/src/basic/fileio.h
@@ -32,11 +32,11 @@ typedef enum {
 } WriteStringFileFlags;
 
 typedef enum {
-        READ_FULL_FILE_SECURE              = 1 << 0,
-        READ_FULL_FILE_UNBASE64            = 1 << 1,
-        READ_FULL_FILE_UNHEX               = 1 << 2,
-        READ_FULL_FILE_WARN_WORLD_READABLE = 1 << 3,
-        READ_FULL_FILE_CONNECT_SOCKET      = 1 << 4,
+        READ_FULL_FILE_SECURE              = 1 << 0, /* erase any buffers we employ internally, after use */
+        READ_FULL_FILE_UNBASE64            = 1 << 1, /* base64 decode what we read */
+        READ_FULL_FILE_UNHEX               = 1 << 2, /* hex decode what we read */
+        READ_FULL_FILE_WARN_WORLD_READABLE = 1 << 3, /* if regular file, log at LOG_WARNING level if access mode above 0700 */
+        READ_FULL_FILE_CONNECT_SOCKET      = 1 << 4, /* if socket inode, connect to it and read off it */
 } ReadFullFileFlags;
 
 int fopen_unlocked(const char *path, const char *options, FILE **ret);