From: Martin Tournoij Date: Fri, 14 Oct 2022 22:20:54 +0000 (+0200) Subject: Reformat comments to textwidth=80 X-Git-Tag: v1.7.2~42 X-Git-Url: https://go.fuhry.dev/?a=commitdiff_plain;h=7b6cd6b15b646e75635744a79e02157a4abeedbf;p=fsnotify.git Reformat comments to textwidth=80 It just looks so *off* to me otherwise. --- diff --git a/backend_fen.go b/backend_fen.go index 8db297a..ad7dac9 100644 --- a/backend_fen.go +++ b/backend_fen.go @@ -172,8 +172,8 @@ func (w *Watcher) isClosed() bool { // Close removes all watches and closes the events channel. func (w *Watcher) Close() error { - // Take the lock used by associateFile to prevent - // lingering events from being processed after the close + // Take the lock used by associateFile to prevent lingering events from + // being processed after the close w.mu.Lock() defer w.mu.Unlock() if w.isClosed() { @@ -268,9 +268,9 @@ func (w *Watcher) Remove(name string) error { return fmt.Errorf("%w: %s", ErrNonExistentWatch, name) } - // The user has expressed an intent. Immediately remove this name - // from whichever watch list it might be in. If it's not in there - // the delete doesn't cause harm. + // The user has expressed an intent. Immediately remove this name from + // whichever watch list it might be in. If it's not in there the delete + // doesn't cause harm. w.mu.Lock() delete(w.watches, name) delete(w.dirs, name) @@ -300,8 +300,8 @@ func (w *Watcher) Remove(name string) error { // readEvents contains the main loop that runs in a goroutine watching for events. func (w *Watcher) readEvents() { - // If this function returns, the watcher has been closed and we can - // close these channels + // If this function returns, the watcher has been closed and we can close + // these channels defer func() { close(w.Errors) close(w.Events) @@ -367,11 +367,10 @@ func (w *Watcher) handleDirectory(path string, stat os.FileInfo, follow bool, ha return handler(path, stat, follow) } -// handleEvent might need to emit more than one fsnotify event -// if the events bitmap matches more than one event type -// (e.g. the file was both modified and had the -// attributes changed between when the association -// was created and the when event was returned) +// handleEvent might need to emit more than one fsnotify event if the events +// bitmap matches more than one event type (e.g. the file was both modified and +// had the attributes changed between when the association was created and the +// when event was returned) func (w *Watcher) handleEvent(event *unix.PortEvent) error { var ( events = event.Events @@ -400,14 +399,13 @@ func (w *Watcher) handleEvent(event *unix.PortEvent) error { reRegister = false } if events&unix.FILE_RENAME_TO != 0 { - // We don't report a Rename event for this case, because - // Rename events are interpreted as referring to the _old_ name - // of the file, and in this case the event would refer to the - // new name of the file. This type of rename event is not - // supported by fsnotify. - - // inotify reports a Remove event in this case, so we simulate - // this here. + // We don't report a Rename event for this case, because Rename events + // are interpreted as referring to the _old_ name of the file, and in + // this case the event would refer to the new name of the file. This + // type of rename event is not supported by fsnotify. + + // inotify reports a Remove event in this case, so we simulate this + // here. if !w.sendEvent(path, Remove) { return nil } @@ -430,31 +428,33 @@ func (w *Watcher) handleEvent(event *unix.PortEvent) error { return nil } - // If we didn't get a deletion the file still exists and we're going to have to watch it again. - // Let's Stat it now so that we can compare permissions and have what we need - // to continue watching the file + // If we didn't get a deletion the file still exists and we're going to have + // to watch it again. Let's Stat it now so that we can compare permissions + // and have what we need to continue watching the file stat, err := os.Lstat(path) if err != nil { - // This is unexpected, but we should still emit an event - // This happens most often on "rm -r" of a subdirectory inside a watched directory - // We get a modify event of something happening inside, but by the time - // we get here, the sudirectory is already gone. Clearly we were watching this path - // but now it is gone. Let's tell the user that it was removed. + // This is unexpected, but we should still emit an event. This happens + // most often on "rm -r" of a subdirectory inside a watched directory We + // get a modify event of something happening inside, but by the time we + // get here, the sudirectory is already gone. Clearly we were watching + // this path but now it is gone. Let's tell the user that it was + // removed. if !w.sendEvent(path, Remove) { return nil } - // Suppress extra write events on removed directories; they are not informative - // and can be confusing. + // Suppress extra write events on removed directories; they are not + // informative and can be confusing. return nil } - // resolve symlinks that were explicitly watched as we would have at Add() time. - // this helps suppress spurious Chmod events on watched symlinks + // resolve symlinks that were explicitly watched as we would have at Add() + // time. this helps suppress spurious Chmod events on watched symlinks if isWatched { stat, err = os.Stat(path) if err != nil { - // The symlink still exists, but the target is gone. Report the Remove similar to above. + // The symlink still exists, but the target is gone. Report the + // Remove similar to above. if !w.sendEvent(path, Remove) { return nil } @@ -497,9 +497,9 @@ func (w *Watcher) handleEvent(event *unix.PortEvent) error { } func (w *Watcher) updateDirectory(path string) error { - // The directory was modified, so we must find unwatched entities and - // watch them. If something was removed from the directory, nothing will - // happen, as everything else should still be watched. + // The directory was modified, so we must find unwatched entities and watch + // them. If something was removed from the directory, nothing will happen, + // as everything else should still be watched. files, err := os.ReadDir(path) if err != nil { return err @@ -532,31 +532,29 @@ func (w *Watcher) associateFile(path string, stat os.FileInfo, follow bool) erro if w.isClosed() { return ErrClosed } - // This is primarily protecting the call to AssociatePath - // but it is important and intentional that the call to - // PathIsWatched is also protected by this mutex. - // Without this mutex, AssociatePath has been seen + // This is primarily protecting the call to AssociatePath but it is + // important and intentional that the call to PathIsWatched is also + // protected by this mutex. Without this mutex, AssociatePath has been seen // to error out that the path is already associated. w.mu.Lock() defer w.mu.Unlock() if w.port.PathIsWatched(path) { - // Remove the old association in favor of this one - // If we get ENOENT, then while the x/sys/unix wrapper - // still thought that this path was associated, - // the underlying event port did not. This call will - // have cleared up that discrepancy. The most likely - // cause is that the event has fired but we haven't - // processed it yet. + // Remove the old association in favor of this one If we get ENOENT, + // then while the x/sys/unix wrapper still thought that this path was + // associated, the underlying event port did not. This call will have + // cleared up that discrepancy. The most likely cause is that the event + // has fired but we haven't processed it yet. err := w.port.DissociatePath(path) if err != nil && err != unix.ENOENT { return err } } - // FILE_NOFOLLOW means we watch symlinks themselves rather than their targets + // FILE_NOFOLLOW means we watch symlinks themselves rather than their + // targets. events := unix.FILE_MODIFIED | unix.FILE_ATTRIB | unix.FILE_NOFOLLOW if follow { - // We *DO* follow symlinks for explicitly watched entries + // We *DO* follow symlinks for explicitly watched entries. events = unix.FILE_MODIFIED | unix.FILE_ATTRIB } return w.port.AssociatePath(path, stat,