From d8cd7742b31178d670a677debb851b961c0464da Mon Sep 17 00:00:00 2001 From: Eli Zaretskii Date: Fri, 25 Jan 2013 11:39:47 +0200 Subject: [PATCH] Update doc string of w32notify-add-watch per discussions in bug #13540. src/w32notify.c (Fw32notify_add_watch): Doc fix. --- src/ChangeLog | 4 ++++ src/w32notify.c | 12 +++++++++--- 2 files changed, 13 insertions(+), 3 deletions(-) diff --git a/src/ChangeLog b/src/ChangeLog index 544cb4f39a2..c6152668a22 100644 --- a/src/ChangeLog +++ b/src/ChangeLog @@ -1,3 +1,7 @@ +2013-01-25 Eli Zaretskii + + * w32notify.c (Fw32notify_add_watch): Doc fix. (Bug#13540) + 2013-01-25 Dmitry Antipov * font.c (num_fonts): Remove the leftover from old diff --git a/src/w32notify.c b/src/w32notify.c index d78e55f43ed..1bcaa794565 100644 --- a/src/w32notify.c +++ b/src/w32notify.c @@ -442,8 +442,8 @@ DEFUN ("w32notify-add-watch", Fw32notify_add_watch, This arranges for filesystem events pertaining to FILE to be reported to Emacs. Use `w32notify-rm-watch' to cancel the watch. -Value is a descriptor for the added watch, or nil if the file -cannot be watched. +Value is a descriptor for the added watch. If the file cannot be +watched for some reason, this function signals a `file-error' error. FILTER is a list of conditions for reporting an event. It can include the following symbols: @@ -476,7 +476,13 @@ following: 'renamed-from' -- a file was renamed whose old name was FILE 'renamed-to' -- a file was renamed and its new name is FILE -FILE is the name of the file whose event is being reported. */) +FILE is the name of the file whose event is being reported. + +Note that some networked filesystems, such as Samba-mounted Unix +volumes, might not send notifications about file changes. In these +cases, this function will return a valid descriptor, but notifications +will never come in. Volumes shared from remote Windows machines do +generate notifications correctly, though. */) (Lisp_Object file, Lisp_Object filter, Lisp_Object callback) { Lisp_Object encoded_file, watch_object, watch_descriptor; -- 2.11.4.GIT