summaryrefslogtreecommitdiffstats
path: root/main.c
diff options
context:
space:
mode:
authorTavian Barnes <tavianator@tavianator.com>2019-02-01 00:04:33 -0500
committerTavian Barnes <tavianator@tavianator.com>2019-02-09 17:06:38 -0500
commitd64db6bad79e10f92c56e5572d6ae9072d62b3a3 (patch)
treef1f334c165afecd1907e9c4cf377878ba172c35a /main.c
parent563b5f9d48e54dc2f5d61a23ce2171e005da201a (diff)
downloadbfs-d64db6bad79e10f92c56e5572d6ae9072d62b3a3.tar.xz
Add some documentation comments
Diffstat (limited to 'main.c')
-rw-r--r--main.c31
1 files changed, 31 insertions, 0 deletions
diff --git a/main.c b/main.c
index 066061d..261711b 100644
--- a/main.c
+++ b/main.c
@@ -14,6 +14,37 @@
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. *
****************************************************************************/
+/**
+ * - main(): the entry point for bfs(1), a breadth-first version of find(1)
+ * - main.c (this file)
+ *
+ * - parse_cmdline(): parses the command line into an expression tree
+ * - cmdline.h (declares the parsed command line structure)
+ * - expr.h (declares the expression tree nodes)
+ * - parse.c (the parser itself)
+ * - opt.c (the expression optimizer)
+ *
+ * - eval_cmdline(): runs the expression on every file it sees
+ * - eval.[ch] (the main evaluation functions)
+ * - exec.[ch] (implements -exec[dir]/-ok[dir])
+ * - printf.[ch] (implements -[f]printf)
+ *
+ * - bftw(): used by eval_cmdline() to walk the directory tree(s)
+ * - bftw.[ch] (an extended version of nftw(3))
+ *
+ * - Utilities:
+ * - bfs.h (constants about bfs itself)
+ * - color.[ch] (for pretty terminal colors)
+ * - diag.[ch] (formats diagnostic messages)
+ * - dstring.[ch] (a dynamic string library)
+ * - mtab.[ch] (parses the system's mount table)
+ * - posix1e.[ch] (wraps POSIX.1e functionality, if present)
+ * - spawn.[ch] (spawns processes)
+ * - stat.[ch] (wraps stat(), or statx() on Linux)
+ * - typo.[ch] (fuzzy matching for typos)
+ * - util.[ch] (everything else)
+ */
+
#include "cmdline.h"
#include "util.h"
#include <errno.h>