From: Eli Zaretskii <eliz@gnu.org>
Date: Wed, 24 Feb 2016 19:54:21 +0000 (+0200)
Subject: Improve documentation of 'save-place-mode'
X-Git-Tag: emacs-25.0.92~45
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=7c81a0b9c68315511b98272d0aa40962d82f6e66;p=emacs.git

Improve documentation of 'save-place-mode'

* lisp/saveplace.el (toggle-save-place): Update the doc string wrt
turning on 'save-place-mode' globally.

* etc/NEWS: Mention the need to call 'save-place-mode' for turning
on the mode in all buffers.
---

diff --git a/etc/NEWS b/etc/NEWS
index f3bb1a6f211..ae34a37b335 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -439,7 +439,13 @@ additionally need to add `getSelection' to `xterm-extra-capabilities'.
 *** `xterm-mouse-mode' now supports mouse-tracking (if your xterm supports it).
 
 ---
-** The `save-place' variable is replaced by `save-place-mode'.
+** To turn on `save-place' mode globally, you must call `(save-place-mode 1)'.
+In order to have the last place in every file saved it is no longer
+sufficient to load the saveplace library and set the default value of
+`save-place' to non-nil.  You must explicitly call the function
+`save-place-mode' with a positive argument instead.  The `save-place'
+variable is now an obsolete alias for `save-place-mode', which
+replaces it.
 
 ** ERC
 
diff --git a/lisp/saveplace.el b/lisp/saveplace.el
index c9148dcfc50..c27df150248 100644
--- a/lisp/saveplace.el
+++ b/lisp/saveplace.el
@@ -155,7 +155,7 @@ the argument is positive.
 To save places automatically in all files, put this in your init
 file:
 
-\(setq-default save-place t)"
+\(save-place-mode 1)"
   (interactive "P")
   (if (not (or buffer-file-name (and (derived-mode-p 'dired-mode)
                                      (boundp 'dired-subdir-alist)