GNU bug report logs - #51217
28.0.60; Use "graphical displays" instead of "X terminals" in docs

Previous Next

Package: emacs;

Reported by: Stefan Kangas <stefan <at> marxist.se>

Date: Thu, 14 Oct 2021 23:47:02 UTC

Severity: wishlist

Tags: patch

Found in version 28.0.60

Fixed in version 28.1

Done: Stefan Kangas <stefan <at> marxist.se>

Bug is archived. No further changes may be made.

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 51217 in the body.
You can then email your comments to 51217 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

View this report as an mbox folder, status mbox, maintainer mbox


Report forwarded to bug-gnu-emacs <at> gnu.org:
bug#51217; Package emacs. (Thu, 14 Oct 2021 23:47:02 GMT) Full text and rfc822 format available.

Acknowledgement sent to Stefan Kangas <stefan <at> marxist.se>:
New bug report received and forwarded. Copy sent to bug-gnu-emacs <at> gnu.org. (Thu, 14 Oct 2021 23:47:02 GMT) Full text and rfc822 format available.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Stefan Kangas <stefan <at> marxist.se>
To: bug-gnu-emacs <at> gnu.org
Subject: 28.0.60; Use "graphical displays" instead of "X terminals" in docs
Date: Thu, 14 Oct 2021 16:45:57 -0700
[Message part 1 (text/plain, inline)]
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.
[0001-Prefer-graphical-displays-to-X-terminals.patch (text/x-diff, attachment)]

Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#51217; Package emacs. (Fri, 15 Oct 2021 06:47:02 GMT) Full text and rfc822 format available.

Message #8 received at 51217 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Stefan Kangas <stefan <at> marxist.se>
Cc: 51217 <at> debbugs.gnu.org
Subject: Re: bug#51217: 28.0.60;
 Use "graphical displays" instead of "X terminals" in docs
Date: Fri, 15 Oct 2021 09:46:23 +0300
> From: Stefan Kangas <stefan <at> 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.




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#51217; Package emacs. (Fri, 15 Oct 2021 09:06:01 GMT) Full text and rfc822 format available.

Message #11 received at 51217 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Kangas <stefan <at> marxist.se>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 51217 <at> debbugs.gnu.org
Subject: Re: bug#51217: 28.0.60; Use "graphical displays" instead of "X
 terminals" in docs
Date: Fri, 15 Oct 2021 04:05:27 -0500
[Message part 1 (text/plain, inline)]
Eli Zaretskii <eliz <at> 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.
[0001-Prefer-graphical-displays-to-X-terminals.patch (text/x-diff, attachment)]

Added tag(s) patch. Request was from Stefan Kangas <stefan <at> marxist.se> to control <at> debbugs.gnu.org. (Fri, 15 Oct 2021 09:06:02 GMT) Full text and rfc822 format available.

Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#51217; Package emacs. (Fri, 15 Oct 2021 10:49:02 GMT) Full text and rfc822 format available.

Message #16 received at 51217 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Stefan Kangas <stefan <at> marxist.se>
Cc: 51217 <at> debbugs.gnu.org
Subject: Re: bug#51217: 28.0.60; Use "graphical displays" instead of "X
 terminals" in docs
Date: Fri, 15 Oct 2021 13:48:21 +0300
> From: Stefan Kangas <stefan <at> marxist.se>
> Date: Fri, 15 Oct 2021 04:05:27 -0500
> Cc: 51217 <at> debbugs.gnu.org
> 
> Fixed in both cases.  Updated patch attached.

Thanks, this LGTM.




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#51217; Package emacs. (Fri, 15 Oct 2021 18:35:02 GMT) Full text and rfc822 format available.

Message #19 received at 51217 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Kangas <stefan <at> marxist.se>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 51217 <at> debbugs.gnu.org
Subject: Re: bug#51217: 28.0.60; Use "graphical displays" instead of "X
 terminals" in docs
Date: Fri, 15 Oct 2021 13:34:20 -0500
close 51217 28.1
thanks

Eli Zaretskii <eliz <at> gnu.org> writes:

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

Thanks, pushed to emacs-28 as commit b5a0eda978.




bug marked as fixed in version 28.1, send any further explanations to 51217 <at> debbugs.gnu.org and Stefan Kangas <stefan <at> marxist.se> Request was from Stefan Kangas <stefan <at> marxist.se> to control <at> debbugs.gnu.org. (Fri, 15 Oct 2021 18:35:02 GMT) Full text and rfc822 format available.

bug archived. Request was from Debbugs Internal Request <help-debbugs <at> gnu.org> to internal_control <at> debbugs.gnu.org. (Sat, 13 Nov 2021 12:24:04 GMT) Full text and rfc822 format available.

This bug report was last modified 2 years and 158 days ago.

Previous Next


GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.