[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Emacs-diffs] emacs-25 8748c21 14/64: Add a doc string to `winner-mode'
From: |
Lars Ingebrigtsen |
Subject: |
[Emacs-diffs] emacs-25 8748c21 14/64: Add a doc string to `winner-mode' |
Date: |
Sun, 01 May 2016 18:18:39 +0000 |
branch: emacs-25
commit 8748c21f7197274177faae7699f5a3d47af4f938
Author: Lars Ingebrigtsen <address@hidden>
Commit: Lars Ingebrigtsen <address@hidden>
Add a doc string to `winner-mode'
* lisp/winner.el (winner-mode): Add a doc string based on the
comments in the file (bug#17716).
(cherry picked from commit 2c3ab9b6e39a3d600e7d82deacc24effaec051bb)
---
lisp/winner.el | 14 +++++++++++++-
1 file changed, 13 insertions(+), 1 deletion(-)
diff --git a/lisp/winner.el b/lisp/winner.el
index 4b27700..9a6f5d5 100644
--- a/lisp/winner.el
+++ b/lisp/winner.el
@@ -346,7 +346,19 @@ You may want to include buffer names such as *Help*,
*Apropos*,
;;;###autoload
-(define-minor-mode winner-mode nil :global t ; let d-m-m make the doc
+(define-minor-mode winner-mode
+ "Toggle Winner mode on or off.
+With a prefix argument ARG, enable Winner mode if ARG is
+positive, and disable it otherwise. If called from Lisp, enable
+the mode if ARG is omitted or nil, and toggle it if ARG is ‘toggle’.
+
+Winner mode is a global minor mode that records the changes in
+the window configuration (i.e. how the frames are partitioned
+into windows) so that the changes can be \"undone\" using the
+command `winner-undo'. By default this one is bound to the key
+sequence `C-c <left>'. If you change your mind (while undoing),
+you can press `C-c <right>' (calling `winner-redo')."
+ :global t
(if winner-mode
(progn
(add-hook 'window-configuration-change-hook 'winner-change-fun)
- [Emacs-diffs] emacs-25 818fb69 42/64: Extremely minor doc fix in Choosing Window, (continued)
- [Emacs-diffs] emacs-25 818fb69 42/64: Extremely minor doc fix in Choosing Window, Lars Ingebrigtsen, 2016/05/01
- [Emacs-diffs] emacs-25 7907b82 51/64: Add a cross ref to Optional Mode Line, Lars Ingebrigtsen, 2016/05/01
- [Emacs-diffs] emacs-25 ecdb340 50/64: Add a doc string to display-time-string, Lars Ingebrigtsen, 2016/05/01
- [Emacs-diffs] emacs-25 7b7b4c2 52/64: Document mode mode line variables, Lars Ingebrigtsen, 2016/05/01
- [Emacs-diffs] emacs-25 db20f89 17/64: Fill font-lock-mode doc string, Lars Ingebrigtsen, 2016/05/01
- [Emacs-diffs] emacs-25 7a03d55 25/64: Clarify whitespace-style doc string, Lars Ingebrigtsen, 2016/05/01
- [Emacs-diffs] emacs-25 396747d 08/64: Don't have the manual claim that it lists all CL incompatibilities, Lars Ingebrigtsen, 2016/05/01
- [Emacs-diffs] emacs-25 0846f21 28/64: Tiny doc clarification for create-fontset-from-fontset-spec, Lars Ingebrigtsen, 2016/05/01
- [Emacs-diffs] emacs-25 dc960d9 15/64: Clarify hi-lock-find-patterns, Lars Ingebrigtsen, 2016/05/01
- [Emacs-diffs] emacs-25 df6cee9 16/64: Wrap the auto-generated doc string, Lars Ingebrigtsen, 2016/05/01
- [Emacs-diffs] emacs-25 8748c21 14/64: Add a doc string to `winner-mode',
Lars Ingebrigtsen <=
- [Emacs-diffs] emacs-25 ff834ff 39/64: Add a link from Tool Bar to Images, Lars Ingebrigtsen, 2016/05/01
- [Emacs-diffs] emacs-25 7350d3d 47/64: apropos-print doc fix, Lars Ingebrigtsen, 2016/05/01
- [Emacs-diffs] emacs-25 8f1e784 32/64: Explictly explain that package-initialize loads the packages, Lars Ingebrigtsen, 2016/05/01
- [Emacs-diffs] emacs-25 8c66ebf 57/64: Further define-obsolete-* doc fixups, Lars Ingebrigtsen, 2016/05/01
- [Emacs-diffs] emacs-25 2abc85e 41/64: Transform mentions of `eval-after-load' to `with-eval-after-load', Lars Ingebrigtsen, 2016/05/01
- [Emacs-diffs] emacs-25 bbda22c 43/64: add-timeout doc fix, Lars Ingebrigtsen, 2016/05/01
- [Emacs-diffs] emacs-25 350792e 62/64: global-eldoc-mode doc fix, Lars Ingebrigtsen, 2016/05/01
- [Emacs-diffs] emacs-25 6b39501 55/64: Mention with-silent-modifications in the lispref manual, Lars Ingebrigtsen, 2016/05/01
- [Emacs-diffs] emacs-25 69f7940 63/64: cua-prefix-override-inhibit-delay doc fix, Lars Ingebrigtsen, 2016/05/01
- [Emacs-diffs] emacs-25 ad5572b 35/64: Fix custom types for cursor-in-non-selected-windows, Lars Ingebrigtsen, 2016/05/01