* bug#18207: erc-truncate-buffer-on-save: misleading variable name and docstring
@ 2014-08-06 10:35 Ivan Shmakov
2015-12-27 20:44 ` Lars Ingebrigtsen
2018-04-14 18:53 ` Lars Ingebrigtsen
0 siblings, 2 replies; 3+ messages in thread
From: Ivan Shmakov @ 2014-08-06 10:35 UTC (permalink / raw)
To: 18207
Package: emacs
Severity: minor
The docstring for erc-truncate-buffer-on-save reads:
Truncate any ERC (channel, query, server) buffer when it is saved.
This is somewhat misleading, as there’re also erc-truncate
module, and, in particular, – the erc-truncate-buffer function,
which are used to truncate buffer /to a given size/ (see
erc-max-buffer-size.) On the contrary, this variable, when
non-nil, forces the buffer to be /completely erased,/ as per the
following lisp/erc/erc-log.el fragment:
434 (if (and erc-truncate-buffer-on-save
435 (called-interactively-p 'interactive))
436 (progn
437 (let ((inhibit-read-only t)) (erase-buffer))
438 (move-marker erc-last-saved-position (point-max))
439 (erc-display-prompt))
I believe that this behavior should be made clear in the
documentation, like:
Erase ERC (channel, query, server) buffers when one is saved.
This function uses `erase-buffer' and has nothing to do with the
`erc-truncate-buffer' function. In order to keep ERC buffer sizes
within a specific limit, you may set `erc-max-buffer-size' and use
`erc-truncate-mode' instead.
It also makes sense to rename this variable (leaving a
compatibility alias.)
--
FSF associate member #7257 http://boycottsystemd.org/ … 3013 B6A0 230E 334A
^ permalink raw reply [flat|nested] 3+ messages in thread
* bug#18207: erc-truncate-buffer-on-save: misleading variable name and docstring
2014-08-06 10:35 bug#18207: erc-truncate-buffer-on-save: misleading variable name and docstring Ivan Shmakov
@ 2015-12-27 20:44 ` Lars Ingebrigtsen
2018-04-14 18:53 ` Lars Ingebrigtsen
1 sibling, 0 replies; 3+ messages in thread
From: Lars Ingebrigtsen @ 2015-12-27 20:44 UTC (permalink / raw)
To: Ivan Shmakov; +Cc: 18207
Ivan Shmakov <ivan@siamics.net> writes:
> Package: emacs
> Severity: minor
>
> The docstring for erc-truncate-buffer-on-save reads:
>
> Truncate any ERC (channel, query, server) buffer when it is saved.
>
> This is somewhat misleading, as there’re also erc-truncate
> module, and, in particular, – the erc-truncate-buffer function,
> which are used to truncate buffer /to a given size/ (see
> erc-max-buffer-size.) On the contrary, this variable, when
> non-nil, forces the buffer to be /completely erased,/ as per the
> following lisp/erc/erc-log.el fragment:
>
> 434 (if (and erc-truncate-buffer-on-save
> 435 (called-interactively-p 'interactive))
> 436 (progn
> 437 (let ((inhibit-read-only t)) (erase-buffer))
> 438 (move-marker erc-last-saved-position (point-max))
> 439 (erc-display-prompt))
>
> I believe that this behavior should be made clear in the
> documentation, like:
>
> Erase ERC (channel, query, server) buffers when one is saved.
>
> This function uses `erase-buffer' and has nothing to do with the
> `erc-truncate-buffer' function. In order to keep ERC buffer sizes
> within a specific limit, you may set `erc-max-buffer-size' and use
> `erc-truncate-mode' instead.
Can you send a patch for this change?
> It also makes sense to rename this variable (leaving a
> compatibility alias.)
I don't think that renaming the variable is worth it.
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog: http://lars.ingebrigtsen.no
^ permalink raw reply [flat|nested] 3+ messages in thread
* bug#18207: erc-truncate-buffer-on-save: misleading variable name and docstring
2014-08-06 10:35 bug#18207: erc-truncate-buffer-on-save: misleading variable name and docstring Ivan Shmakov
2015-12-27 20:44 ` Lars Ingebrigtsen
@ 2018-04-14 18:53 ` Lars Ingebrigtsen
1 sibling, 0 replies; 3+ messages in thread
From: Lars Ingebrigtsen @ 2018-04-14 18:53 UTC (permalink / raw)
To: Ivan Shmakov; +Cc: 18207
Ivan Shmakov <ivan@siamics.net> writes:
> The docstring for erc-truncate-buffer-on-save reads:
>
> Truncate any ERC (channel, query, server) buffer when it is saved.
>
> This is somewhat misleading, as there’re also erc-truncate
> module, and, in particular, – the erc-truncate-buffer function,
> which are used to truncate buffer /to a given size/ (see
> erc-max-buffer-size.) On the contrary, this variable, when
> non-nil, forces the buffer to be /completely erased,/ as per the
> following lisp/erc/erc-log.el fragment:
>
> 434 (if (and erc-truncate-buffer-on-save
> 435 (called-interactively-p 'interactive))
> 436 (progn
> 437 (let ((inhibit-read-only t)) (erase-buffer))
> 438 (move-marker erc-last-saved-position (point-max))
> 439 (erc-display-prompt))
>
> I believe that this behavior should be made clear in the
> documentation, like:
>
> Erase ERC (channel, query, server) buffers when one is saved.
I've now made a similar change to Emacs 27.1.
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog: http://lars.ingebrigtsen.no
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2018-04-14 18:53 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2014-08-06 10:35 bug#18207: erc-truncate-buffer-on-save: misleading variable name and docstring Ivan Shmakov
2015-12-27 20:44 ` Lars Ingebrigtsen
2018-04-14 18:53 ` Lars Ingebrigtsen
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).