[Emacs-diffs] /srv/bzr/emacs/trunk r111601: Update doc string of w32notify-add-watch per discussions in bug #13540.

[Eli Zaretskii]

------------------------------------------------------------
revno: 111601
fixes bug: http://debbugs.gnu.org/13540
committer: Eli Zaretskii <address@hidden>
branch nick: trunk
timestamp: Fri 2013-01-25 11:39:47 +0200
message:
  Update doc string of w32notify-add-watch per discussions in bug #13540.
  
   src/w32notify.c (Fw32notify_add_watch): Doc fix.
modified:
  src/ChangeLog
  src/w32notify.c

=== modified file 'src/ChangeLog'
--- a/src/ChangeLog     2013-01-25 06:31:41 +0000
+++ b/src/ChangeLog     2013-01-25 09:39:47 +0000
@@ -1,3 +1,7 @@
+2013-01-25  Eli Zaretskii  <address@hidden>
+
+       * w32notify.c (Fw32notify_add_watch): Doc fix.  (Bug#13540)
+
 2013-01-25  Dmitry Antipov  <address@hidden>
 
        * font.c (num_fonts): Remove the leftover from old

=== modified file 'src/w32notify.c'
--- a/src/w32notify.c   2013-01-02 16:30:50 +0000
+++ b/src/w32notify.c   2013-01-25 09:39:47 +0000
@@ -442,8 +442,8 @@
 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 @@
   '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;