Fix up header guards.
[pintos-anon] / src / filesys / directory.h
index 8e4ed47c8b4c0c196de7d016278f6d2a35fa028f..4464d466baffa0b04fca022e8f9d72939f7b6884 100644 (file)
@@ -1,25 +1,28 @@
-#ifndef HEADER_DIRECTORY_H
-#define HEADER_DIRECTORY_H 1
+#ifndef FILESYS_DIRECTORY_H
+#define FILESYS_DIRECTORY_H
 
 #include <stdbool.h>
 #include <stddef.h>
-#include "disk.h"
+#include "devices/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;
@@ -33,4 +36,4 @@ bool dir_remove (struct dir *, const char *name);
 void dir_list (const struct dir *);
 void dir_dump (const struct dir *);
 
-#endif /* directory.h */
+#endif /* filesys/directory.h */