From: Martin Tournoij <martin@arp242.net>
Date: Fri, 14 Oct 2022 22:28:33 +0000 (+0200)
Subject: Tweak docs a bit
X-Git-Tag: v1.7.2~41
X-Git-Url: https://go.fuhry.dev/?a=commitdiff_plain;h=36569c71da5201382cc4b164c1be7c2f8ac43f13;p=fsnotify.git

Tweak docs a bit
---

diff --git a/README.md b/README.md
index bd2f76f..91080ba 100644
--- a/README.md
+++ b/README.md
@@ -4,24 +4,20 @@ Windows, Linux, macOS, BSD, and illumos.
 Go 1.16 or newer is required; the full documentation is at
 https://pkg.go.dev/github.com/fsnotify/fsnotify
 
-**It's best to read the documentation at pkg.go.dev, as it's pinned to the last
-released version, whereas this README is for the last development version which
-may include additions/changes.**
-
 ---
 
 Platform support:
 
-| Adapter               | OS             | Status                                                       |
-| --------------------- | -------------- | ------------------------------------------------------------ |
+| Backend               | OS             | Status                                                       |
+| :-------------------- | :------------- | :----------------------------------------------------------- |
 | inotify               | Linux 2.6.32+  | Supported                                                    |
 | kqueue                | BSD, macOS     | Supported                                                    |
 | ReadDirectoryChangesW | Windows        | Supported                                                    |
 | FEN                   | illumos        | Supported in main branch                                     |
-| FSEvents              | macOS          | [Planned](https://github.com/fsnotify/fsnotify/issues/11)    |
-| fanotify              | Linux 5.9+     | [Maybe](https://github.com/fsnotify/fsnotify/issues/114)     |
+| FSEvents              | macOS          | [Not yet](https://github.com/fsnotify/fsnotify/issues/11)    |
+| fanotify              | Linux 5.9+     | [Not yet](https://github.com/fsnotify/fsnotify/issues/114)   |
 | USN Journals          | Windows        | [Maybe](https://github.com/fsnotify/fsnotify/issues/53)      |
-| Polling               | *All*          | [Maybe](https://github.com/fsnotify/fsnotify/issues/9)       |
+| Polling               | *All*          | [Not yet](https://github.com/fsnotify/fsnotify/issues/9)     |
 
 Linux, macOS, and illumos should include Android, iOS, and Solaris, but these
 are currently untested.
diff --git a/fsnotify.go b/fsnotify.go
index 5b6f74e..2b570fa 100644
--- a/fsnotify.go
+++ b/fsnotify.go
@@ -1,5 +1,12 @@
 // Package fsnotify provides a cross-platform interface for file system
 // notifications.
+//
+// Currently supported systems:
+//
+//    Linux 2.6.32+    via inotify
+//    BSD, macOS       via kqueue
+//    Windows          via ReadDirectoryChangesW
+//    illumos          via FEN
 package fsnotify
 
 import (
@@ -37,7 +44,7 @@ const (
 	Chmod
 )
 
-// Common errors that can be reported by a watcher
+// Common errors that can be reported.
 var (
 	ErrNonExistentWatch = errors.New("fsnotify: can't remove non-existent watcher")
 	ErrEventOverflow    = errors.New("fsnotify: queue overflow")