]> go.fuhry.dev Git - fsnotify.git/commit
Update documentation and examples (#496)
authorMartin Tournoij <martin@arp242.net>
Wed, 10 Aug 2022 15:10:01 +0000 (17:10 +0200)
committerGitHub <noreply@github.com>
Wed, 10 Aug 2022 15:10:01 +0000 (17:10 +0200)
commit61a05ce2c490294c9f945bf93cdc3340d67fb0e2
tree39b05ec552d2959101deb522980474d16315a1e0
parente180a87abd14c3ba3929d07273989b5ab913ea18
Update documentation and examples (#496)

Update some documentation and add various examples. I added the examples
as subcommands of ./cmd/fsnotify, so they're directly runnable, and it's
at least guaranteed they compile.

This adds some simpler test cases so it's easier to verify it actually
works as documented on all platforms, and it adds internal.Debug() for
all platforms, which is useful in dev.

Fixes 49
Fixes 74
Fixes 94
Fixes 122
Fixes 238
Fixes 372
Fixes 401
26 files changed:
README.md
backend_fen.go
backend_inotify.go
backend_kqueue.go
backend_other.go
backend_windows.go
cmd/fsnotify/dedup.go [new file with mode: 0644]
cmd/fsnotify/file.go [new file with mode: 0644]
cmd/fsnotify/main.go
cmd/fsnotify/watch.go [new file with mode: 0644]
fsnotify.go
fsnotify_test.go
helpers_test.go
internal/darwin.go
internal/debug_darwin.go [new file with mode: 0644]
internal/debug_dragonfly.go [new file with mode: 0644]
internal/debug_freebsd.go [new file with mode: 0644]
internal/debug_kqueue.go [new file with mode: 0644]
internal/debug_linux.go [new file with mode: 0644]
internal/debug_netbsd.go [new file with mode: 0644]
internal/debug_openbsd.go [new file with mode: 0644]
internal/debug_windows.go [new file with mode: 0644]
internal/freebsd.go [new file with mode: 0644]
internal/unix.go
internal/windows.go
mkdoc.zsh [new file with mode: 0755]