From 5d410cb7d35edeba1d12d797c0353a793d383f15 Mon Sep 17 00:00:00 2001
From: Nathan Fisher <nfisher.sr@gmail.com>
Date: Mon, 7 Aug 2023 19:15:20 -0400
Subject: [PATCH] Declare why certain headers are included

---
 include/haggis.h |  4 ++--
 include/jobq.h   |  2 --
 src/haggis.c     | 18 ++++++++----------
 src/jobq.c       |  1 +
 4 files changed, 11 insertions(+), 14 deletions(-)

diff --git a/include/haggis.h b/include/haggis.h
index 645fc3c..1972463 100644
--- a/include/haggis.h
+++ b/include/haggis.h
@@ -34,8 +34,8 @@
 #define HAGGIS_H
 
 #include "linklist.h"
-#include <stdint.h>
-#include <stdio.h>
+#include <stdint.h>        // uint<x>_t
+#include <stdio.h>         // FILE
 
 typedef uint8_t u8;
 
diff --git a/include/jobq.h b/include/jobq.h
index 2b09e68..79aff62 100644
--- a/include/jobq.h
+++ b/include/jobq.h
@@ -34,8 +34,6 @@
 #define JOBQ_H
 
 #include <pthread.h>
-#include <stddef.h>
-#include <stdlib.h>
 
 #include "haggis.h"
 
diff --git a/src/haggis.c b/src/haggis.c
index dae53ce..80400bc 100644
--- a/src/haggis.c
+++ b/src/haggis.c
@@ -30,10 +30,9 @@
  *      other than his own.
  */
 
-#include <fcntl.h>
-#include <limits.h>
+#include <limits.h>          // PATH_MAX
 #include <md5.h>
-#include <stdint.h>
+#include <stdint.h>          // uint<x>_t
 
 #if defined(__FreeBSD__) || defined(__DragonFly__)
 #include <sha.h>
@@ -48,13 +47,12 @@
 #include <sha2.h>
 #endif /* if defined (__FreeBSD__) */
 
-#include <stddef.h>
-#include <stdio.h>
-#include <stdlib.h>
-#include <string.h>
-#include <unistd.h>
-#include <sys/stat.h>
-#include <sys/sysmacros.h>
+#include <stdio.h>           // fopen, fread, fwrite, FILE
+#include <stdlib.h>          // free, malloc
+#include <string.h>          // memcpy, strlen
+#include <unistd.h>          // readlink
+#include <sys/stat.h>        // stat
+#include <sys/sysmacros.h>   // major, minor, dev_t
 
 #include "bytes.h"
 #include "haggis.h"
diff --git a/src/jobq.c b/src/jobq.c
index e402dce..85367e3 100644
--- a/src/jobq.c
+++ b/src/jobq.c
@@ -29,6 +29,7 @@
  *      as such so that the author does not get blamed for bugs
  *      other than his own.
 */
+#include <stdlib.h>    // free, malloc
 
 #include "jobq.h"