Document list.h source

[wimlib] / src / list.h

diff --git a/src/list.h b/src/list.h
index c34706fb2b138fb61b85ca50bb91d23e51ef8ea0..ffce657076653d9e85878e933139b61ee584b2cd 100644 (file)
--- a/src/list.h
+++ b/src/list.h
@@ -1,3 +1,8 @@
+
+/*
+ * This file is based on include/linux/list.h in the Linux kernel source code.
+ */
+
 #ifndef _LINUX_LIST_H
 #define _LINUX_LIST_H
 
@@ -34,6 +39,13 @@ struct hlist_node {
        struct hlist_node *next, **pprev;
 };
 
+/* 
+ * Structure used to create a linked list of streams that share the same lookup
+ * table entry.  This structure may be embedded in either a dentry (for the
+ * un-named data stream) or an ads_entry (for an alternate data stream).  The
+ * @type field indicates which of these structures the stream_list_head is
+ * embedded in.
+ */
 struct stream_list_head {
        struct list_head list;
        enum {