summaryrefslogtreecommitdiffstats
path: root/src/bftw.c
diff options
context:
space:
mode:
authorTavian Barnes <tavianator@tavianator.com>2024-02-14 11:16:17 -0500
committerTavian Barnes <tavianator@tavianator.com>2024-02-14 11:17:01 -0500
commit16ba60f128f6a099f4d47291e570019a7c897f00 (patch)
tree3b8c1574ba4f85f1275a7639ac6e45e44a67d595 /src/bftw.c
parented36b75a120830d835194fc793cfcb212ab67929 (diff)
downloadbfs-16ba60f128f6a099f4d47291e570019a7c897f00.tar.xz
bftw: Document which bftw_file nodes go with which lists
Diffstat (limited to 'src/bftw.c')
-rw-r--r--src/bftw.c20
1 files changed, 17 insertions, 3 deletions
diff --git a/src/bftw.c b/src/bftw.c
index 664651c..6f52299 100644
--- a/src/bftw.c
+++ b/src/bftw.c
@@ -196,12 +196,26 @@ struct bftw_file {
/** The root under which this file was found. */
struct bftw_file *root;
- /** The next file to open/close/visit. */
+ /**
+ * List node for:
+ *
+ * bftw_queue::buffer
+ * bftw_queue::waiting
+ * bftw_file_open()::parents
+ */
struct bftw_file *next;
- /** The next directory to read. */
+
+ /**
+ * List node for:
+ *
+ * bftw_queue::ready
+ * bftw_state::to_close
+ */
struct { struct bftw_file *next; } ready;
- /** LRU list node. */
+ /**
+ * List node for bftw_cache.
+ */
struct {
struct bftw_file *prev;
struct bftw_file *next;