bug#35146: 27.0.50; Improve documentation for Winner mode

bug#35146: 27.0.50; Improve documentation for Winner mode

[Mauro Aranda]

[-- Attachment #1.1: Type: text/plain, Size: 144 bytes --]

Tags: patch

Hello.

I attach a patch that documents Winner mode customizable
variables.

Please, consider my suggestion.

Best regards,
Mauro.

[-- Attachment #1.2: Type: text/html, Size: 237 bytes --]

[-- Attachment #2: 0001-Document-Winner-mode-user-options.patch --]
[-- Type: text/x-patch, Size: 1886 bytes --]

From 8f8de11fe23a4dc7bc9197f4d6ebb0569bde9c93 Mon Sep 17 00:00:00 2001
From: Mauro Aranda <maurooaranda@gmail.com>
Date: Thu, 4 Apr 2019 12:02:04 -0300
Subject: [PATCH] Document Winner mode user options

* doc/emacs/windows.texi (Window Convenience): Add documentation for
the user options winner-dont-bind-my-keys, winner-ring-size and
winner-boring-buffers.
---
 doc/emacs/windows.texi | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/doc/emacs/windows.texi b/doc/emacs/windows.texi
index ece5313..4b39e8b 100644
--- a/doc/emacs/windows.texi
+++ b/doc/emacs/windows.texi
@@ -535,6 +535,9 @@ Window Convenience
 @section Convenience Features for Window Handling
 
 @findex winner-mode
+@vindex winner-dont-bind-my-keys
+@vindex winner-ring-size
+@vindex winner-boring-buffers
 @cindex Winner mode
 @cindex mode, Winner
 @cindex undoing window configuration changes
@@ -546,7 +549,14 @@ Window Convenience
 @code{winner-mode}.  When the mode is enabled, @kbd{C-c left}
 (@code{winner-undo}) undoes the last window configuration change.  If
 you change your mind while undoing, you can redo the changes you had
-undone using @kbd{C-c right} (@code{M-x winner-redo}).
+undone using @kbd{C-c right} (@code{M-x winner-redo}).  To prevent
+Winner mode from binding @kbd{C-c left} and @kbd{C-c right}, you can
+customize the variable @code{winner-dont-bind-my-keys} to a
+non-@code{nil} value.  By default, Winner mode stores a maximum of 200
+window configurations per frame, but you can change that by modifying
+the variable @code{winner-ring-size}.  If there are some buffers whose
+windows you wouldn't want Winner mode to restore, add their names to
+the list variable @code{winner-boring-buffers}.
 
   Follow mode (@kbd{M-x follow-mode}) synchronizes several windows on
 the same buffer so that they always display adjacent sections of that
-- 
2.7.4

bug#35146: 27.0.50; Improve documentation for Winner mode

[Lars Ingebrigtsen]

Mauro Aranda <maurooaranda@gmail.com> writes:

> I attach a patch that documents Winner mode customizable
> variables.

Thanks; looks good to me.  I've applied the patch to the Emacs trunk.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no