The old README was one dense specification: long sentences, lists chained with commas, exceptions ahead of the rules, and release history in the user text. This rewrite leads with what the program is and how to use it, then gives a reference for the settings, each subcommand, the database, the output formats, the progress display and the exit codes. Non-goals come before the reference; the constraints, the entrypoints and the build come last. Every statement was checked against the code on next and against what the built binary prints on small trees. The section names the code comments cite are kept. Five comments in main_test.go cite Settings, and one each in scan_test.go, trees_test.go and exclude_test.go cites what the README now says. TODO.md records the step. Model: fable-5-1
This commit is contained in:
+3
-1
@@ -17,7 +17,9 @@ import (
|
||||
func TestDefaultExcludes(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
// README "Rules for the walk": each system's list.
|
||||
// README "Rules for the walk": the Linux and macOS lists, and none
|
||||
// on any other system. The Windows list exists in the code only: the
|
||||
// binary does not build for Windows, so the README leaves it out.
|
||||
cases := map[string][]string{
|
||||
goosLinux: {"/proc", "/sys", "/dev", "/run", "/tmp", "/var/tmp"},
|
||||
goosDarwin: {
|
||||
|
||||
Reference in New Issue
Block a user