unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Stefan Kangas <stefan@marxist.se>
Cc: emacs-devel@gnu.org
Subject: Re: Rename "window" to "pane" (after Emacs 27)
Date: Wed, 30 Oct 2019 19:29:33 +0200	[thread overview]
Message-ID: <83v9s6nnuq.fsf@gnu.org> (raw)
In-Reply-To: <CADwFkmkZ6RPrYSrTpM9woTVMG=cH7_iMmvn6Mw+JykZPcEQQEw@mail.gmail.com> (message from Stefan Kangas on Tue, 29 Oct 2019 00:07:33 +0100)

> From: Stefan Kangas <stefan@marxist.se>
> Date: Tue, 29 Oct 2019 00:07:33 +0100
> 
> 1. Change the names of the Lisp level functions to be named "window"
>    instead of "pane" in window.c and window.el.  Make the old names
>    into defaliases.  Update calls in Emacs to use the new names.  (I'm
>    not sure if it would make sense to rename "window.{c,el}" to
>    "pane.{c,el}" given how that makes it harder to browse Git
>    history.)
> 
> 2. Update elisp and emacs manual to introduce "pane" as a synonym for
>    "window".  Make it clear that "pane" is the new and preferred
>    terminology, but that old code and documentation might use "window"
>    to mean the same thing.
> 
> 3. Update doc strings of all functions changed above to talk about
>    panes instead of windows.
> 
> I think this could be done in a feature branch, and, if the experiment
> looks good, maybe we could considering merging it for Emacs 28.

What would be the criterion for success?

> I'd suggest to *not* do the following as part of the above initial plan:
> 
> - Update the C level code to use the new "pane" terminology.
> - Update the Lisp code to internally only refer to "panes" (e.g. in
>   let-bindings)
> - Rename functions outside of window.el or window.c (OTOH, there's
>   only ~500 of them, so maybe it's feasible?)
> - Update all doc strings of all functions in Emacs where "window"
>   shows up.
> - Mark the above aliases obsolete.  (We could do that later.)
> 
> The excluded points would of course, in the context of a rename, make
> sense to do eventually.  I believe they are too big tasks to do in a
> single feature branch (perhaps we could do parts).  I'd therefore
> suggest to first introduce the new terminology as the preferred one,
> merge that, and then make these other changes incrementally over time.

To tell the truth, I don't see how we could leave anything unrenamed.
The code is supposed to speak for itself, so if we want to use "pane",
we need to use it everywhere.  C code is no different from Lisp,
because people who develop and maintain Emacs modify both, so having
schizophrenic terminology will get in the way, certainly in the way of
those who didn't have the current terminology burnt into their muscle
memory.

Likewise any arguments we current call WINDOW: they will have to be
renamed to PANE.  And if we find arguments called WIND or WNDW (I hope
there are none), we will have to do something with those as well.

Local variables is a tougher nut, but ideally we should rename those
as well.

So I think if we are going to do this, we need to do all of it, lock,
stock, and barrel.



  parent reply	other threads:[~2019-10-30 17:29 UTC|newest]

Thread overview: 25+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-10-28 23:07 Rename "window" to "pane" (after Emacs 27) Stefan Kangas
2019-10-29  0:28 ` Filipp Gunbin
2019-10-29  1:55   ` Stefan Kangas
2019-10-30 17:29 ` Eli Zaretskii [this message]
2019-10-31  2:07 ` Richard Stallman
2020-03-31 18:50   ` Bruno Félix Rezende Ribeiro
2020-04-01  2:07     ` Richard Stallman
2020-04-01 12:03       ` Stefan Kangas
2020-04-01 14:56         ` Drew Adams
2020-04-01 15:13           ` Stefan Monnier
2020-04-01 17:04             ` Stefan Kangas
2020-04-01 17:30               ` Drew Adams
2020-04-02  2:34                 ` Richard Stallman
2020-04-02  4:51                   ` Jean-Christophe Helary
2020-04-03  2:52                     ` Richard Stallman
2020-04-01 15:25           ` Juanma Barranquero
2020-04-03 17:59           ` Sam Steingold
2020-04-03 18:34             ` Drew Adams
2020-04-03 18:53               ` Dmitry Gutov
2020-04-03 18:56                 ` Drew Adams
2020-04-03 18:54             ` Dmitry Gutov
2020-04-08 15:34               ` Sam Steingold
2020-04-08 17:29                 ` Dmitry Gutov
2020-04-02  2:31         ` Richard Stallman
2020-04-02  2:31         ` Richard Stallman

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=83v9s6nnuq.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=emacs-devel@gnu.org \
    --cc=stefan@marxist.se \
    /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).