From 53bcfc19dc94648f76d8eb7f72abe98fe5f143a7 Mon Sep 17 00:00:00 2001
From: Brian Carrier <carrier@sleuthkit.org>
Date: Fri, 28 Feb 2020 12:22:51 -0500
Subject: [PATCH] Added comments about what types are used where

---
 tsk/fs/fs_open.c  | 2 ++
 tsk/fs/fs_types.c | 3 +++
 2 files changed, 5 insertions(+)

diff --git a/tsk/fs/fs_open.c b/tsk/fs/fs_open.c
index e1d0cb4a6..3a564f0dc 100755
--- a/tsk/fs/fs_open.c
+++ b/tsk/fs/fs_open.c
@@ -129,6 +129,8 @@ tsk_fs_open_img_decrypt(TSK_IMG_INFO * a_img_info, TSK_OFF_T a_offset,
         char* name;
         TSK_FS_INFO* (*open)(TSK_IMG_INFO*, TSK_OFF_T,
                                  TSK_FS_TYPE_ENUM, uint8_t);
+        // This type should be the _DETECT version because it used
+        // during autodetection
         TSK_FS_TYPE_ENUM type;
     } FS_OPENERS[] = {
         { "NTFS",     ntfs_open,    TSK_FS_TYPE_NTFS_DETECT    },
diff --git a/tsk/fs/fs_types.c b/tsk/fs/fs_types.c
index 6f656afa8..6ba88f0e6 100644
--- a/tsk/fs/fs_types.c
+++ b/tsk/fs/fs_types.c
@@ -34,6 +34,9 @@ typedef struct {
 /** \internal
  * The table used to parse input strings - supports
  * legacy strings - in order of expected usage
+ *
+ * All unique TSK_FS_TYPE_ENUM values should be in here with a unique 
+ * name so that we can map between values and names. 
  */
 static FS_TYPES fs_type_table[] = {
     {"ntfs", TSK_FS_TYPE_NTFS_DETECT, "NTFS"},
-- 
GitLab