unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Daniel Nagy <danielnagy@posteo.de>
To: emacs-devel@gnu.org
Subject: Definition reasoning of revert-buffer-function, should it be defvar-local?
Date: Tue, 10 Aug 2021 13:51:38 +0000	[thread overview]
Message-ID: <874kbxwgmu.fsf@posteo.de> (raw)

Hello,

I want to understand the reasoning behind the definition and the intention of
the variable `revert-buffer-function`.

In `files.el` I see the following definition:

>    (put 'revert-buffer-function 'permanent-local t)
>    (defvar revert-buffer-function #'revert-buffer--default)

The first line suggests to me, that the intention of the variable is that it is
supposed to be buffer-local, but `defvar-local` was not used. This means, that
if I open a new buffer and `(setq revert-buffer-function #'something)` then that
variable is assigned globally, breaking its behaviour. I know that I can use
`setq-local`, but using `defvar-local` would prevent accidents.

My question is, why was `defvar-local` not used? Should we change it ? Should we
change all these constructs where it says `(put ... 'permanent-local t)(defvar
...)`?

In `bookmark.el` I can also see the invocation `(setq revert-buffer-function
...)` but that instance does not leak out its value to global Emacs because its
mode is derived from `tabulated-list-mode` and that already uses `setq-local` to
make the value buffer-local.

Thank you already for your help.

For the more curious, this question sparked during this GitHub issue:
https://github.com/magit/magit/issues/4432

Best,
Daniel



             reply	other threads:[~2021-08-10 13:51 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-08-10 13:51 Daniel Nagy [this message]
2021-08-10 14:34 ` Definition reasoning of revert-buffer-function, should it be defvar-local? Andreas Schwab
2021-08-10 14:46   ` Tassilo Horn

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=874kbxwgmu.fsf@posteo.de \
    --to=danielnagy@posteo.de \
    --cc=emacs-devel@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).