diff options
| author | Tavian Barnes <tavianator@tavianator.com> | 2022-05-16 16:30:58 -0400 |
|---|---|---|
| committer | Tavian Barnes <tavianator@tavianator.com> | 2022-05-16 17:09:29 -0400 |
| commit | bedd8f409a41bf2a2c9650eeda56effeda852817 (patch) | |
| tree | 65843d59dd66a8d739eed836fb1484183f98311e /docs | |
| parent | 5f3c1e965720d46bc00d2f4d98ac6bc34f8a022e (diff) | |
| download | bfs-bedd8f409a41bf2a2c9650eeda56effeda852817.tar.xz | |
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.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/BUILDING.md | 8 | ||||
| -rw-r--r-- | docs/HACKING.md | 2 | ||||
| -rw-r--r-- | docs/USAGE.md | 3 |
3 files changed, 6 insertions, 7 deletions
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 |