emcrisostomo / fswatch

A cross-platform file change monitor with multiple backends: Apple OS X File System Events, *BSD kqueue, Solaris/Illumos File Events Notification, Linux inotify, Microsoft Windows and a stat()-based backend.
https://emcrisostomo.github.io/fswatch/
GNU General Public License v3.0
4.96k stars 327 forks source link

Out of date list of monitors at wiki page or obsolete/removed monitors for Solaris and Windows? #252

Open birbilis opened 3 years ago

birbilis commented 3 years ago

at http://emcrisostomo.github.io/fswatch/ one reads: ...

but at https://github.com/emcrisostomo/fswatch/wiki those two are missing in the list of supported monitors

are they still in there? is the 2nd text just out-of-date?

birbilis commented 3 years ago

just noticed this page does list those two monitors missing from the wiki page: https://github.com/emcrisostomo/fswatch in a bit of a different order from the http://emcrisostomo.github.io/fswatch/ page

birbilis commented 3 years ago

Also https://github.com/emcrisostomo/fswatch/wiki/How-to-Choose-a-Monitor speaks of FSEvents and inotify and kqueue but doesn't have any recommendations about other monitors, instead suggests using the poll monitor if the previous 3 aren't available

at https://github.com/emcrisostomo/fswatch/wiki/Monitors again it doesn't list Solaris and Windows ones

at http://emcrisostomo.github.io/fswatch/doc/1.14.0/libfswatch.html/ it does list them (obviously need to keep a list of where monitors are mentioned to update all if more monitors are added in the future or if monitor-related recommendations change etc.)

birbilis commented 3 years ago

also at http://emcrisostomo.github.io/fswatch/ it writes on the header text: "A cross-platform file change monitor with multiple backends: Apple OS X File System Events API, *BSD kqueue, Solaris/Illumos File Events Notification, Linux inotify and a stat()-based backend." but that doesn't mention "Windows ReadDirectoryChangesW" which is mentioned though in that page's text below

SamuelMarks commented 2 years ago

Agreed they should all be updated to be consistent with each other

emcrisostomo commented 1 year ago

Thanks for the report, I agree with you, the wiki hasn't caught up with the texinfo and doxygen documentation, from which the PDF manuals are generated. I'll review this.