From: Kevin Day <thekevinday@gmail.com>
Date: Sat, 29 Aug 2020 02:47:04 +0000 (-0500)
Subject: Cleanup: add comments to file.h.
X-Git-Tag: 0.5.0~36
X-Git-Url: https://git.kevux.org/?a=commitdiff_plain;h=c6527b9e64ea626a868bb37dd9c22629585166fd;p=fll

Cleanup: add comments to file.h.
---

diff --git a/level_0/f_file/c/file.h b/level_0/f_file/c/file.h
index d286e2b..78e8573 100644
--- a/level_0/f_file/c/file.h
+++ b/level_0/f_file/c/file.h
@@ -45,8 +45,8 @@ extern "C" {
  * Provide common file-typ specific data types.
  */
 #ifndef _di_f_file_types_
-  #define f_file_default_read_size  8192 // default to 8k read sizes.
-  #define f_file_default_write_size 8192 // default to 8k write sizes.
+  #define f_file_default_read_size  8192 // default to 8k read sizes. // @fixme: rename and move into _di_f_file_type_
+  #define f_file_default_write_size 8192 // default to 8k write sizes. // @fixme: rename and move into _di_f_file_type_
 #endif // _di_f_file_types_
 
 /**
@@ -70,6 +70,8 @@ extern "C" {
 
 /**
  * Provide file type macros.
+ *
+ * These type macros are of size 32-bit (int32_t).
  */
 #ifndef _di_f_file_type_
   #define f_file_type_mask S_IFMT
@@ -1143,6 +1145,8 @@ extern "C" {
  *
  * This does not set mode based on umask(), which is already applied if f_file_mode_from_string() was used to create mode_change.
  *
+ * @fixme apparently "u+g" is valid such that the mode from the group (g) is applied to the user (u) mode.
+ *
  * @param mode_file
  *   The mode_t value representing the file's current mode.
  *   This is expected to be populated from (struct stat).st_mode.