bug#51217: 28.0.60; Use "graphical displays" instead of "X terminals" in docs

bug#51217: 28.0.60; Use "graphical displays" instead of "X terminals" in docs

[Stefan Kangas]

[-- Attachment #1: Type: text/plain, Size: 485 bytes --]

Severity: wishlist

In (info "(elisp) Other Char Bits"), I read:

    Emacs uses the 2**25 bit to indicate that the shift key
    was used in typing a control character.  This distinction is possible
    only when you use X terminals or other special terminals; ordinary text
    terminals do not report the distinction.

Can we change "when you use X terminals or other special terminals" to
"on a graphical display"?

See the attached patch that also fixes some other similar cases.

[-- Attachment #2: 0001-Prefer-graphical-displays-to-X-terminals.patch --]
[-- Type: text/x-diff, Size: 3265 bytes --]

From f88d6e715948b80952f34de2ec5eafbccca92d70 Mon Sep 17 00:00:00 2001
From: Stefan Kangas <stefan@marxist.se>
Date: Fri, 15 Oct 2021 01:24:36 +0200
Subject: [PATCH] Prefer "graphical displays" to "X terminals"

* doc/lispref/objects.texi (Other Char Bits):
* lisp/bindings.el:
* lisp/gnus/gnus-undo.el (gnus-undo-mode-map): Say "graphical display"
instead of "X terminal"; the latter term is archaic.

* doc/lispref/objects.texi (Ctl-Char Syntax): Say "text terminal"
instead of "ordinary text terminal"; most users use a graphical
display these days.
---
 doc/lispref/objects.texi | 15 +++++++--------
 lisp/bindings.el         |  2 +-
 lisp/gnus/gnus-undo.el   |  2 +-
 3 files changed, 9 insertions(+), 10 deletions(-)

diff --git a/doc/lispref/objects.texi b/doc/lispref/objects.texi
index 365d5ac8d6..499fa78876 100644
--- a/doc/lispref/objects.texi
+++ b/doc/lispref/objects.texi
@@ -516,9 +516,9 @@ Ctl-Char Syntax
 2**26
 @end ifnottex
 bit as well as the code for the corresponding non-control character.
-Ordinary text terminals have no way of generating non-@acronym{ASCII}
-control characters, but you can generate them straightforwardly using
-X and other window systems.
+Text terminals have no way of generating non-@acronym{ASCII} control
+characters, but you can generate them straightforwardly using X and
+other window systems.
 
   For historical reasons, Emacs treats the @key{DEL} character as
 the control equivalent of @kbd{?}:
@@ -588,11 +588,10 @@ Other Char Bits
 2**25
 @end ifnottex
 bit to indicate that the shift key was used in typing a control
-character.  This distinction is possible only when you use X terminals
-or other special terminals; ordinary text terminals do not report the
-distinction.  The Lisp syntax for the shift bit is @samp{\S-}; thus,
-@samp{?\C-\S-o} or @samp{?\C-\S-O} represents the shifted-control-o
-character.
+character.  This distinction is possible only on a graphical display;
+text terminals do not report the distinction.  The Lisp syntax for the
+shift bit is @samp{\S-}; thus, @samp{?\C-\S-o} or @samp{?\C-\S-O}
+represents the shifted-control-o character.
 
 @cindex hyper characters
 @cindex super characters
diff --git a/lisp/bindings.el b/lisp/bindings.el
index 2c45710a58..303a03b0fa 100644
--- a/lisp/bindings.el
+++ b/lisp/bindings.el
@@ -981,7 +981,7 @@ ctl-x-map
 (define-key ctl-x-map "\M-:" 'repeat-complex-command)
 (define-key ctl-x-map "u" 'undo)
 (put 'undo :advertised-binding [?\C-x ?u])
-;; Many people are used to typing C-/ on X terminals and getting C-_.
+;; Many people are used to typing C-/ on graphical displays and getting C-_.
 (define-key global-map [?\C-/] 'undo)
 (define-key global-map "\C-_" 'undo)
 ;; Richard said that we should not use C-x <uppercase letter> and I have
diff --git a/lisp/gnus/gnus-undo.el b/lisp/gnus/gnus-undo.el
index 182c8743e0..ba01b49faf 100644
--- a/lisp/gnus/gnus-undo.el
+++ b/lisp/gnus/gnus-undo.el
@@ -79,7 +79,7 @@ gnus-undo-mode-map
   "\M-\C-_" #'gnus-undo
   "\C-_" #'gnus-undo
   "\C-xu" #'gnus-undo
-  ;; many people are used to type `C-/' on X terminals and get `C-_'.
+  ;; many people are used to type `C-/' on graphical displays and get `C-_'.
   [(control /)] #'gnus-undo)
 
 (defun gnus-undo-make-menu-bar ()
-- 
2.30.2

bug#51217: 28.0.60; Use "graphical displays" instead of "X terminals" in docs

[Eli Zaretskii]

> From: Stefan Kangas <stefan@marxist.se>
> Date: Thu, 14 Oct 2021 16:45:57 -0700
> 
> In (info "(elisp) Other Char Bits"), I read:
> 
>     Emacs uses the 2**25 bit to indicate that the shift key
>     was used in typing a control character.  This distinction is possible
>     only when you use X terminals or other special terminals; ordinary text
>     terminals do not report the distinction.
> 
> Can we change "when you use X terminals or other special terminals" to
> "on a graphical display"?

Something like that, yes.

> -Ordinary text terminals have no way of generating non-@acronym{ASCII}
> -control characters, but you can generate them straightforwardly using
> -X and other window systems.
> +Text terminals have no way of generating non-@acronym{ASCII} control
> +characters, but you can generate them straightforwardly using X and
> +other window systems.

I think this paragraph is no longer true, at least not universally, on
modern text-mode terminals -- assuming we include text-terminal
emulators.  So I suggest to say something like

  Not all text terminals have a way of generating non-@acronym{ASCII}
  control characters, but you can generate them straightforwardly
  using X and other window systems.

>  bit to indicate that the shift key was used in typing a control
> -character.  This distinction is possible only when you use X terminals
> -or other special terminals; ordinary text terminals do not report the
> -distinction.  The Lisp syntax for the shift bit is @samp{\S-}; thus,
> -@samp{?\C-\S-o} or @samp{?\C-\S-O} represents the shifted-control-o
> -character.
> +character.  This distinction is possible only on a graphical display;

I'd prefer to keep the reference to X, something like

  This distinction is possible only when you use a graphical display,
  such as a GUI display on X.

> -;; Many people are used to typing C-/ on X terminals and getting C-_.
> +;; Many people are used to typing C-/ on graphical displays and getting C-_.

In code comments, I'd prefer to use "GUI frames" instead.  it's
shorter and more accurate, IMO.

> -  ;; many people are used to type `C-/' on X terminals and get `C-_'.
> +  ;; many people are used to type `C-/' on graphical displays and get `C-_'.

Likewise.

Thanks.

bug#51217: 28.0.60; Use "graphical displays" instead of "X terminals" in docs

[Stefan Kangas]

[-- Attachment #1: Type: text/plain, Size: 895 bytes --]

Eli Zaretskii <eliz@gnu.org> writes:

>   Not all text terminals have a way of generating non-@acronym{ASCII}
>   control characters, but you can generate them straightforwardly
>   using X and other window systems.

Thanks, I went with this variation:

    Not all text terminals can generate non-@acronym{ASCII} control
    characters, but it is straightforward to generate them using X and
    other window systems.

> I'd prefer to keep the reference to X, something like
>
>   This distinction is possible only when you use a graphical display,
>   such as a GUI display on X.

Fixed.

>> -;; Many people are used to typing C-/ on X terminals and getting C-_.
>> +;; Many people are used to typing C-/ on graphical displays and getting C-_.
>
> In code comments, I'd prefer to use "GUI frames" instead.  it's
> shorter and more accurate, IMO.

Fixed in both cases.  Updated patch attached.

[-- Attachment #2: 0001-Prefer-graphical-displays-to-X-terminals.patch --]
[-- Type: text/x-diff, Size: 3047 bytes --]

From 01640bb16d596e7a7ed8d8aabc1977f6f73efc6d Mon Sep 17 00:00:00 2001
From: Stefan Kangas <stefan@marxist.se>
Date: Fri, 15 Oct 2021 01:24:36 +0200
Subject: [PATCH] Prefer "graphical displays" to "X terminals"

* doc/lispref/objects.texi (Ctl-Char Syntax): Fix incorrect remark;
some text terminals can generate ASCII control characters.
(Other Char Bits):
* lisp/bindings.el:
* lisp/gnus/gnus-undo.el (gnus-undo-mode-map): Say "graphical display"
and "GUI display" instead of "X terminal"; the latter term is
archaic.  (Bug#51217)
---
 doc/lispref/objects.texi | 10 +++++-----
 lisp/bindings.el         |  2 +-
 lisp/gnus/gnus-undo.el   |  2 +-
 3 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/doc/lispref/objects.texi b/doc/lispref/objects.texi
index 365d5ac8d6..a20343f4c7 100644
--- a/doc/lispref/objects.texi
+++ b/doc/lispref/objects.texi
@@ -516,9 +516,9 @@ Ctl-Char Syntax
 2**26
 @end ifnottex
 bit as well as the code for the corresponding non-control character.
-Ordinary text terminals have no way of generating non-@acronym{ASCII}
-control characters, but you can generate them straightforwardly using
-X and other window systems.
+Not all text terminals can generate non-@acronym{ASCII} control
+characters, but it is straightforward to generate them using X and
+other window systems.
 
   For historical reasons, Emacs treats the @key{DEL} character as
 the control equivalent of @kbd{?}:
@@ -588,8 +588,8 @@ Other Char Bits
 2**25
 @end ifnottex
 bit to indicate that the shift key was used in typing a control
-character.  This distinction is possible only when you use X terminals
-or other special terminals; ordinary text terminals do not report the
+character.  This distinction is possible only on a graphical display
+such as a GUI display on X; text terminals do not report the
 distinction.  The Lisp syntax for the shift bit is @samp{\S-}; thus,
 @samp{?\C-\S-o} or @samp{?\C-\S-O} represents the shifted-control-o
 character.
diff --git a/lisp/bindings.el b/lisp/bindings.el
index 2c45710a58..121e484a0e 100644
--- a/lisp/bindings.el
+++ b/lisp/bindings.el
@@ -981,7 +981,7 @@ ctl-x-map
 (define-key ctl-x-map "\M-:" 'repeat-complex-command)
 (define-key ctl-x-map "u" 'undo)
 (put 'undo :advertised-binding [?\C-x ?u])
-;; Many people are used to typing C-/ on X terminals and getting C-_.
+;; Many people are used to typing C-/ on GUI frames and getting C-_.
 (define-key global-map [?\C-/] 'undo)
 (define-key global-map "\C-_" 'undo)
 ;; Richard said that we should not use C-x <uppercase letter> and I have
diff --git a/lisp/gnus/gnus-undo.el b/lisp/gnus/gnus-undo.el
index 64ed2bbad6..07cf5d495a 100644
--- a/lisp/gnus/gnus-undo.el
+++ b/lisp/gnus/gnus-undo.el
@@ -81,7 +81,7 @@ gnus-undo-mode-map
       "\M-\C-_"     gnus-undo
       "\C-_"        gnus-undo
       "\C-xu"       gnus-undo
-      ;; many people are used to type `C-/' on X terminals and get `C-_'.
+      ;; Many people are used to type `C-/' on GUI frames and get `C-_'.
       [(control /)] gnus-undo)
     map))
 
-- 
2.30.2

bug#51217: 28.0.60; Use "graphical displays" instead of "X terminals" in docs

[Eli Zaretskii]

> From: Stefan Kangas <stefan@marxist.se>
> Date: Fri, 15 Oct 2021 04:05:27 -0500
> Cc: 51217@debbugs.gnu.org
> 
> Fixed in both cases.  Updated patch attached.

Thanks, this LGTM.

bug#51217: 28.0.60; Use "graphical displays" instead of "X terminals" in docs

[Stefan Kangas]

close 51217 28.1
thanks

Eli Zaretskii <eliz@gnu.org> writes:

>> From: Stefan Kangas <stefan@marxist.se>
>> Date: Fri, 15 Oct 2021 04:05:27 -0500
>> Cc: 51217@debbugs.gnu.org
>>
>> Fixed in both cases.  Updated patch attached.
>
> Thanks, this LGTM.

Thanks, pushed to emacs-28 as commit b5a0eda978.