From: Michael Orlitzky <michael@orlitzky.com>
Date: Mon, 26 Feb 2018 14:59:48 +0000 (-0500)
Subject: Clean up a few "include" statements, and document them.
X-Git-Tag: v0.1.0~10
X-Git-Url: https://gitweb.michael.orlitzky.com/?a=commitdiff_plain;h=bf1ac1a44c7ae16f8c01cfe9ce1c8f930e3957e6;p=apply-default-acl.git

Clean up a few "include" statements, and document them.
---

diff --git a/src/apply-default-acl.c b/src/apply-default-acl.c
index c075059..f8ae4cd 100644
--- a/src/apply-default-acl.c
+++ b/src/apply-default-acl.c
@@ -9,14 +9,13 @@
 #define _XOPEN_SOURCE 500
 #define _GNU_SOURCE
 
-#include <errno.h>
-#include <fcntl.h>  /* AT_FOO constants */
-#include <ftw.h>    /* nftw() et al. */
-#include <getopt.h>
-#include <stdbool.h>
-#include <stdio.h>
-#include <stdlib.h>
-#include <unistd.h>
+#include <fcntl.h>   /* AT_FOO constants */
+#include <ftw.h>     /* nftw() et al. */
+#include <getopt.h>  /* getopt_long() */
+#include <stdbool.h> /* the "bool" type */
+#include <stdio.h>   /* perror() */
+#include <stdlib.h>  /* EXIT_FAILURE, EXIT_SUCCESS */
+#include <unistd.h>  /* faccessat() */
 
 #include "libadacl.h"
 
diff --git a/src/libadacl.c b/src/libadacl.c
index 28d5782..69f2073 100644
--- a/src/libadacl.c
+++ b/src/libadacl.c
@@ -8,21 +8,20 @@
 /* Enables get_current_dir_name() in unistd.h */
 #define _GNU_SOURCE
 
-#include <errno.h>
-#include <fcntl.h>
-#include <libgen.h> /* basename(), dirname() */
-#include <limits.h> /* PATH_MAX */
-#include <stdbool.h>
-#include <stdio.h>
-#include <stdlib.h>
-#include <string.h>
-#include <sys/stat.h>
-#include <unistd.h> /* get_current_dir_name() */
+#include <errno.h>    /* ELOOP, EINVAL, etc. */
+#include <fcntl.h>    /* openat() */
+#include <libgen.h>   /* basename(), dirname() */
+#include <limits.h>   /* PATH_MAX */
+#include <stdbool.h>  /* the "bool" type */
+#include <stdio.h>    /* perror(), snprintf() */
+#include <stdlib.h>   /* free() */
+#include <string.h>   /* strdup() */
+#include <sys/stat.h> /* fstat() */
+#include <unistd.h>   /* get_current_dir_name() */
 
 /* ACLs */
 #include <acl/libacl.h> /* acl_get_perm, not portable */
-#include <sys/types.h>
-#include <sys/acl.h>
+#include <sys/acl.h>    /* all other acl_foo functions */
 
 #include "libadacl.h"