Add comments.

[pintos-anon] / src / filesys / directory.h

diff --git a/src/filesys/directory.h b/src/filesys/directory.h
index 8e4ed47c8b4c0c196de7d016278f6d2a35fa028f..f5f5ebdde8c041b85cf8046eb6fceb604f38e6ac 100644 (file)
--- a/src/filesys/directory.h
+++ b/src/filesys/directory.h
@@ -6,20 +6,23 @@
 #include "disk.h"
 
 /* Maximum length of a filename.
-   This is the traditional UNIX maximum. */
-#define FILENAME_LEN_MAX 14
+   This is the traditional UNIX maximum.
+   (This macro name comes from POSIX.1.) */
+#define NAME_MAX 14
 
+/* A directory. */
 struct dir 
   {
-    size_t entry_cnt;
-    struct dir_entry *entries;
+    size_t entry_cnt;           /* Number of entries. */
+    struct dir_entry *entries;  /* Array of entries. */
   };
 
+/* A single directory entry. */
 struct dir_entry 
   {
-    bool in_use;
-    char name[FILENAME_LEN_MAX + 1];
-    disk_sector_t filehdr_sector;
+    bool in_use;                        /* In use or free? */
+    char name[NAME_MAX + 1];            /* Null terminated file name. */
+    disk_sector_t filehdr_sector;       /* Sector number of header. */
   };
 
 struct file;