From edc93a5ce6a377e9b4a1b355c494196ba0aea376 Mon Sep 17 00:00:00 2001 From: "Basil L. Contovounesios" Date: Wed, 8 Sep 2021 12:41:07 +0200 Subject: [PATCH 1/4] ; Fix grammar in efaq.texi on Emacs vs XEmacs. --- doc/misc/efaq.texi | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/misc/efaq.texi b/doc/misc/efaq.texi index 0be35396b80..9c92b2d93dd 100644 --- a/doc/misc/efaq.texi +++ b/doc/misc/efaq.texi @@ -1467,7 +1467,7 @@ derived from a prerelease version of Emacs 19. In this FAQ, we use the name ``Emacs'' only for the official version. XEmacs last released a new version on January 30, 2009, and it lacks -many important features that exists in Emacs. In the past, it was not +many important features that exist in Emacs. In the past, it was not uncommon for Emacs packages to include code for compatibility with XEmacs. Nowadays, although some packages still maintain such compatibility code, several of the more popular built-in and third From 252a769b11689d13796db6f76c2935374796b079 Mon Sep 17 00:00:00 2001 From: Stephen Gildea Date: Fri, 10 Sep 2021 20:21:34 -0700 Subject: [PATCH 2/4] ; * doc/lispref/files.texi (Changing Files): Fix xref to file-modes. 'file-modes' is in node "Testing Accessibility", not "File Attributes". --- doc/lispref/files.texi | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/lispref/files.texi b/doc/lispref/files.texi index 4235c4900a3..3b1f2d5cb80 100644 --- a/doc/lispref/files.texi +++ b/doc/lispref/files.texi @@ -1824,7 +1824,7 @@ Interactively, @var{mode} is read from the minibuffer using @code{read-file-modes} (see below), which lets the user type in either an integer or a string representing the permissions symbolically. -@xref{File Attributes}, for the function @code{file-modes}, which +@xref{Testing Accessibility}, for the function @code{file-modes}, which returns the permissions of a file. @end deffn From fb1f0dfec968d74e887c457e34300ae02a328d52 Mon Sep 17 00:00:00 2001 From: Olivier Certner Date: Wed, 13 Jan 2021 17:39:54 +0100 Subject: [PATCH 3/4] ERC: Track: Fix documentation of structure of 'erc-modified-channels-alist' * lisp/erc/erc-track.el (erc-modified-channels-alist): Fix the docstring: each element is a dotted list where the last cdr is sometimes a proper list, making the element only sometimes a proper list. --- lisp/erc/erc-track.el | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/lisp/erc/erc-track.el b/lisp/erc/erc-track.el index 11270770659..b6055b6fdab 100644 --- a/lisp/erc/erc-track.el +++ b/lisp/erc/erc-track.el @@ -281,14 +281,17 @@ nil - don't add to mode line." (defvar erc-modified-channels-alist nil "An ALIST used for tracking channel modification activity. -Each element looks like (BUFFER COUNT FACE) where BUFFER is a buffer -object of the channel the entry corresponds to, COUNT is a number -indicating how often activity was noticed, and FACE is the face to use -when displaying the buffer's name. See `erc-track-faces-priority-list', -and `erc-track-showcount'. +Each element is a list of the form (BUFFER COUNT . FACE) where +BUFFER is a buffer object of the channel the entry corresponds +to, COUNT is a number indicating how often activity was noticed, +and FACE is a face (or a list of faces) to use when displaying the +buffer's name. Entries in this list should only happen for buffers where activity occurred -while the buffer was not visible.") +while the buffer was not visible. + +See also `erc-track-faces-priority-list', +`erc-track-faces-normal-list' and `erc-track-showcount'.") (defcustom erc-track-showcount nil "If non-nil, count of unseen messages will be shown for each channel." From d7f4cc0974645cc6a295740afe85c6e21d956119 Mon Sep 17 00:00:00 2001 From: Olivier Certner Date: Thu, 14 Jan 2021 18:20:26 +0100 Subject: [PATCH 4/4] ERC: Track: Clarify documentation on tracked buffers and add references * lisp/erc/erc-track.el (erc-modified-channels-alist): Clarify what the list contains. Add references to variables and functions involved in displaying tracked buffers from this list. (erc-make-mode-line-buffer-name): Describe exactly the algorithm, and reference custom variables that influence it. --- lisp/erc/erc-track.el | 27 +++++++++++++++++++-------- 1 file changed, 19 insertions(+), 8 deletions(-) diff --git a/lisp/erc/erc-track.el b/lisp/erc/erc-track.el index b6055b6fdab..66fde693089 100644 --- a/lisp/erc/erc-track.el +++ b/lisp/erc/erc-track.el @@ -284,14 +284,19 @@ nil - don't add to mode line." Each element is a list of the form (BUFFER COUNT . FACE) where BUFFER is a buffer object of the channel the entry corresponds to, COUNT is a number indicating how often activity was noticed, -and FACE is a face (or a list of faces) to use when displaying the -buffer's name. +and FACE is a face (or a list of faces, combined as usual) to use +when displaying the buffer's name in the mode line. -Entries in this list should only happen for buffers where activity occurred -while the buffer was not visible. +Entries in this list are only added/updated for buffers that were +not visible when activity occurred in them, and are removed for +each buffer as soon as it becomes visible again (or if the server +is disconnected, provided `erc-track-remove-disconnected-buffers' +is true). -See also `erc-track-faces-priority-list', -`erc-track-faces-normal-list' and `erc-track-showcount'.") +For how the face is chosen for a buffer, see +`erc-track-find-face' and `erc-track-priority-faces-only'. For +how buffers are then displayed in the mode line, see +`erc-modified-channels-display'.") (defcustom erc-track-showcount nil "If non-nil, count of unseen messages will be shown for each channel." @@ -656,8 +661,14 @@ ARGS are ignored." "The face to use when mouse is over channel names in the mode line.") (defun erc-make-mode-line-buffer-name (string buffer &optional faces count) - "Return STRING as a button that switches to BUFFER when clicked. -If FACES are provided, color STRING with them." + "Returns a button that switches to BUFFER when clicked. +STRING is the string in the button. It is possibly suffixed with +the number of unread messages, according to variables +`erc-track-showcount' and `erc-track-showcount-string'. + +If `erc-track-use-faces' is true and FACES are provided, format +STRING with them. When the mouse hovers above the button, STRING +is displayed according to `erc-track-mouse-face'." ;; We define a new sparse keymap every time, because 1. this data ;; structure is very small, the alternative would require us to ;; defvar a keymap, 2. the user is not interested in customizing it