From: Glenn Morris <rgm@gnu.org>
Date: Wed, 26 Mar 2014 01:24:01 +0000 (-0400)
Subject: Doc tweaks related to file locking
X-Git-Tag: emacs-25.0.90~2640^2~332
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=0b4fe0787b957624ebffa5d123c69d5c0a5d69e2;p=emacs.git

Doc tweaks related to file locking

* doc/lispref/files.texi (File Locks): All systems support locking.

* src/filelock.c (Flock_buffer): Doc tweak.
---

diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 870d2dd5d37..71af1bc66a0 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,7 @@
+2014-03-26  Glenn Morris  <rgm@gnu.org>
+
+	* files.texi (File Locks): All systems support locking.
+
 2014-03-22  Glenn Morris  <rgm@gnu.org>
 
 	* commands.texi (Defining Commands):
diff --git a/doc/lispref/files.texi b/doc/lispref/files.texi
index 3818c18f57a..a00fa5b4795 100644
--- a/doc/lispref/files.texi
+++ b/doc/lispref/files.texi
@@ -709,15 +709,15 @@ some other job.
 This function locks the file @var{filename}, if the current buffer is
 modified.  The argument @var{filename} defaults to the current buffer's
 visited file.  Nothing is done if the current buffer is not visiting a
-file, or is not modified, or if the system does not support locking.
+file, or is not modified, or if the option @code{create-lockfiles} is
+@code{nil}.
 @end defun
 
 @defun unlock-buffer
 This function unlocks the file being visited in the current buffer,
 if the buffer is modified.  If the buffer is not modified, then
 the file should not be locked, so this function does nothing.  It also
-does nothing if the current buffer is not visiting a file, or if the
-system does not support locking.
+does nothing if the current buffer is not visiting a file, or is not locked.
 @end defun
 
 @defopt create-lockfiles
diff --git a/src/ChangeLog b/src/ChangeLog
index 87c2d364b05..05c5b42ef90 100644
--- a/src/ChangeLog
+++ b/src/ChangeLog
@@ -1,5 +1,7 @@
 2014-03-26  Glenn Morris  <rgm@gnu.org>
 
+	* filelock.c (Flock_buffer): Doc tweak.
+
 	* buffer.c (Frestore_buffer_modified_p, Fkill_buffer):
 	* emacs.c (shut_down_emacs):
 	* fileio.c (Finsert_file_contents, write_region):
diff --git a/src/filelock.c b/src/filelock.c
index cc5c821cadd..f857c488143 100644
--- a/src/filelock.c
+++ b/src/filelock.c
@@ -771,7 +771,9 @@ DEFUN ("lock-buffer", Flock_buffer, Slock_buffer,
        0, 1, 0,
        doc: /* Lock FILE, if current buffer is modified.
 FILE defaults to current buffer's visited file,
-or else nothing is done if current buffer isn't visiting a file.  */)
+or else nothing is done if current buffer isn't visiting a file.
+
+If the option `create-lockfiles' is nil, this does nothing.  */)
   (Lisp_Object file)
 {
   if (NILP (file))