From bedd8f409a41bf2a2c9650eeda56effeda852817 Mon Sep 17 00:00:00 2001
From: Tavian Barnes <tavianator@tavianator.com>
Date: Mon, 16 May 2022 16:30:58 -0400
Subject: Makefile: Split build into bin and obj directories

This also moves the main binary from ./bfs to ./bin/bfs, and ./tests.sh
to ./tests/tests.sh, with the goal of keeping the repository root clean.
---
 docs/BUILDING.md | 8 ++++----
 docs/HACKING.md  | 2 +-
 docs/USAGE.md    | 3 +--
 3 files changed, 6 insertions(+), 7 deletions(-)

(limited to 'docs')

diff --git a/docs/BUILDING.md b/docs/BUILDING.md
index ebab60b..edbce3a 100644
--- a/docs/BUILDING.md
+++ b/docs/BUILDING.md
@@ -113,24 +113,24 @@ Most of them are *snapshot tests* which compare `bfs`'s output to a known-good c
 You can pass the name of a particular test case (or a few) to run just those tests.
 For example:
 
-    $ ./tests.sh test_basic
+    $ ./tests/tests.sh test_basic
 
 If you need to update the reference snapshot, pass `--update`.
 It can be handy to generate the snapshot with a different `find` implementation to ensure the output is correct, for example:
 
-    $ ./tests.sh test_basic --bfs=find --update
+    $ ./tests/tests.sh test_basic --bfs=find --update
 
 But keep in mind, other `find` implementations may not be correct.
 To my knowledge, no other implementation passes even the POSIX-compatible subset of the tests:
 
-    $ ./tests.sh --bfs=find --posix
+    $ ./tests/tests.sh --bfs=find --posix
     ...
     tests passed: 89
     tests failed: 5
 
 Run
 
-    $ ./tests.sh --help
+    $ ./tests/tests.sh --help
 
 for more details.
 
diff --git a/docs/HACKING.md b/docs/HACKING.md
index 7dfc497..08ddac2 100644
--- a/docs/HACKING.md
+++ b/docs/HACKING.md
@@ -43,5 +43,5 @@ function test_something() {
 
 `basic` is one of the directory trees generated for test cases; others include `links`, `loops`, `deep`, and `rainbow`.
 
-Run `./tests.sh test_something --update` to generate the reference snapshot (and don't forget to `git add` it).
+Run `./tests/tests.sh test_something --update` to generate the reference snapshot (and don't forget to `git add` it).
 Finally, add the test case to one of the arrays `posix_tests`, `bsd_tests`, `gnu_tests`, or `bfs_tests`, depending on which `find` implementations it should be compatible with.
diff --git a/docs/USAGE.md b/docs/USAGE.md
index 9f76f16..e2cff44 100644
--- a/docs/USAGE.md
+++ b/docs/USAGE.md
@@ -13,7 +13,6 @@ $ bfs
 ./completions
 ./docs
 ./src
-./tests.sh
 ./tests
 ./completions/bfs.bash
 ./completions/bfs.zsh
@@ -81,11 +80,11 @@ There are other operators like `-or`:
 ```console
 $ bfs -name '*.md' -or -name '*.sh'
 ./README.md
-./tests.sh
 ./tests/find-color.sh
 ./tests/ls-color.sh
 ./tests/remove-sibling.sh
 ./tests/sort-args.sh
+./tests/tests.sh
 ./docs/CHANGELOG.md
 ./docs/HACKING.md
 ./docs/BUILDING.md
-- 
cgit v1.2.3