bug#66282: 26.3; Doc string of `overlay-arrow-string'

bug#66282: 26.3; Doc string of `overlay-arrow-string'

[Drew Adams]

"String to display as an arrow in non-window frames."

What's a non-window frame?



In GNU Emacs 26.3 (build 1, x86_64-w64-mingw32)
 of 2019-08-29
Repository revision: 96dd0196c28bc36779584e47fffcca433c9309cd
Windowing system distributor `Microsoft Corp.', version 10.0.19045
Configured using:
 `configure --without-dbus --host=x86_64-w64-mingw32
 --without-compress-install 'CFLAGS=-O2 -static -g3''

bug#66282: 26.3; Doc string of `overlay-arrow-string'

[Stefan Kangas]

Drew Adams <drew.adams@oracle.com> writes:

> "String to display as an arrow in non-window frames."
>
> What's a non-window frame?

Should it say "text terminals" perhaps?

This is the terminology used in (info "(elisp) Frames"):

       There are two classes of terminals: “text terminals” and
    “graphical terminals”.

We also have (info "(emacs) Non-Window Terminals"), which seems to be
speaking of "text terminals".  Should that node be renamed to "text
terminals" for consistency?

bug#66282: 26.3; Doc string of `overlay-arrow-string'

[Eli Zaretskii]

> From: Stefan Kangas <stefankangas@gmail.com>
> Date: Sat, 30 Sep 2023 14:40:26 -0700
> 
> Drew Adams <drew.adams@oracle.com> writes:
> 
> > "String to display as an arrow in non-window frames."
> >
> > What's a non-window frame?
> 
> Should it say "text terminals" perhaps?

I fixed it to say "text-mode frames" instead.  ("Terminal" is slightly
more confusing in this case, and "text-mode frames" says exactly what
we should say.)

> We also have (info "(emacs) Non-Window Terminals"), which seems to be
> speaking of "text terminals".  Should that node be renamed to "text
> terminals" for consistency?

Yes, probably.

bug#66282: 26.3; Doc string of `overlay-arrow-string'

[Stefan Kangas]

Eli Zaretskii <eliz@gnu.org> writes:

>> We also have (info "(emacs) Non-Window Terminals"), which seems to be
>> speaking of "text terminals".  Should that node be renamed to "text
>> terminals" for consistency?
>
> Yes, probably.

Thanks, I did that on emacs-29.  I also updated most other references to
"non-window" terminals and displays.  See [1: 6bdc5cfe384] and please
feel free to tweak it.

We now only have three references to "non-window" left in doc/**/*texi:

./misc/modus-themes.texi:2597:When Emacs runs in a non-windowed
session its color reproduction
./misc/efaq.texi:1787:Colors and faces are supported in non-windowed
mode, i.e., on Unix and
./lispref/os.texi:561:new text terminal.  (This applies when Emacs
starts up in non-windowed

We also have these in src/:

./src/xdisp.c:22826:   Used for non-window-redisplay windows, and for
windows without left
./src/xdisp.c:36677:    doc: /* String to display as an arrow in
non-window frames.
./src/xdisp.c:36724:    doc: /* Pixels per inch value for non-window
system displays.

And these in lisp/:

./htmlfontify.el:106:The following might be useful when running
non-windowed or in batch mode:
./emulation/cua-base.el:414:On non-window systems, use
`cua-rectangle-terminal-modifier-key'.
./vc/ediff-init.el:567:and ediff-after-flag.  On a non-window system,
differences are always
./emacs-lisp/tcover-ses.el:675:    ;;ses-create-header-string behaves
differently in a non-window environment

[1: 6bdc5cfe384]: 2023-10-01 13:58:53 +0200
  Doc fix; more consistently refer to "text terminals"
  https://git.savannah.gnu.org/cgit/emacs.git/commit/?id=6bdc5cfe384a017d775421e03ed4d77feddb76b9

bug#66282: 26.3; Doc string of `overlay-arrow-string'

[Eli Zaretskii]

> From: Stefan Kangas <stefankangas@gmail.com>
> Date: Sun, 1 Oct 2023 05:12:18 -0700
> Cc: drew.adams@oracle.com, 66282@debbugs.gnu.org
> 
> We also have these in src/:
> 
> ./src/xdisp.c:22826:   Used for non-window-redisplay windows, and for
> windows without left
> ./src/xdisp.c:36677:    doc: /* String to display as an arrow in
> non-window frames.
> ./src/xdisp.c:36724:    doc: /* Pixels per inch value for non-window
> system displays.
> 
> And these in lisp/:
> 
> ./htmlfontify.el:106:The following might be useful when running
> non-windowed or in batch mode:
> ./emulation/cua-base.el:414:On non-window systems, use
> `cua-rectangle-terminal-modifier-key'.
> ./vc/ediff-init.el:567:and ediff-after-flag.  On a non-window system,
> differences are always
> ./emacs-lisp/tcover-ses.el:675:    ;;ses-create-header-string behaves
> differently in a non-window environment

These are okay, they don't use "non-window frames" (with the single
exception of the doc string which I already fixed, and you probably
have the old version of).  They use other terminology, which has its
place.  "Windows-system" is our terminology for the various GUI
environments, and "window redisplay" (as opposed to "frame redisplay")
is correct terminology for GUI redisplay, where each window has its
own glyph matrix and manages its memory, see the large comment at the
beginning of xdisp.c.

bug#66282: 26.3; Doc string of `overlay-arrow-string'

[Drew Adams]

Thanks.
___

I'm guessing (could be wrong) that "no-window"
and maybe "non-window" here is a legacy from
when X Window was first supported.

In that context the "window" referred to an
X-Window graphic displa, IOW, akin to a
window-manager window, as opposed to referring
to an Emacs window.

And maybe even the command-line option `-nw'
follows this.  (emacs) Non-Window Terminals.

Just guessing.

bug#66282: 26.3; Doc string of `overlay-arrow-string'

[Eli Zaretskii]

> From: Drew Adams <drew.adams@oracle.com>
> Date: Sat, 30 Sep 2023 20:15:56 +0000
> 
> "String to display as an arrow in non-window frames."
> 
> What's a non-window frame?

Thanks, fixed.