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
5.07k stars 330 forks source link

Typo in Documentation #325

Open larelogio opened 1 month ago

larelogio commented 1 month ago

@ Numeric Event Flags of Invoking fswatch

@ line 1978 of fswatch/doc/fswatch.texi

$$ r = e \wedge b $$

sould probably be

$$ r = e \wedge n $$

to be compatible with the explanation @ lines 1971-1983

To check whether a given event flag is present when processing
@command{fswatch} output, iti s sufficient to check whether its bit is
set to 1 in the event value.  Let's suppose we want to check whether
the event flag whose value is @math{e} is present in a record whose
flag numerical value is @math{n}.  If the result @math{r} of
@tex
$$ r = e \wedge b $$
@end tex
@noindent
where @math{\wedge} is the bitwise @command{and} operator, is @math{r
> 0}, then the flag @math{e} is present in @math{n}.

As an aditional note "iti s" @ line 1972 could be "it's" or "it is" and "its bit" could be "it's bit".