]> git.eshelyaron.com Git - emacs.git/commitdiff
Fix NEWS entries and documentation for underline styles
authorPo Lu <luangruo@yahoo.com>
Mon, 29 Apr 2024 00:49:28 +0000 (08:49 +0800)
committerEshel Yaron <me@eshelyaron.com>
Mon, 29 Apr 2024 19:47:57 +0000 (21:47 +0200)
* doc/lispref/display.texi (Face Attributes):

* etc/NEWS: Revise to not mislead users as to where these
attributes are available.

(cherry picked from commit 8cd9ca22362f8646e7717d2a18bcdb86780f423a)

doc/lispref/display.texi
etc/NEWS

index 439f9843d8b5fdc287c797615f1ac2b3c91bdda2..c243c2a39ef53f02ed1eccc74366e73d88799dbd 100644 (file)
@@ -2687,12 +2687,14 @@ meaning the foreground color of the face.  Omitting the attribute
 @code{:color} means to use the foreground color of the face.
 @var{style} is a symbol which sets the line-style to of the underline.
 It should be one of @code{line}, @code{double-line}, @code{wave},
-@code{dots}, or @code{dashes}.  GUI frames only support @code{line} and
-@code{wave}.  Terminal frames can support all aforementioned underline
-styles.  Omitting the attribute @code{:style} means to use a straight
-line.  @var{position}, if non-@code{nil}, means to display the underline
-at the descent of the text, instead of at the baseline level.  If it is
-a number, then it specifies the amount of pixels above the descent to
+@code{dots}, or @code{dashes}.  GUI frames under most window systems
+support all the aforementioned underline styles, while on text terminals
+@code{double-line}, @code{wave} and @code{dots} are contingent on the
+availability of the @code{Smulx} or @code{Su} terminfo capabilities.
+Omitting the attribute @code{:style} means to use a straight line.
+@var{position}, if non-@code{nil}, means to display the underline at the
+descent of the text, instead of at the baseline level.  If it is a
+number, then it specifies the amount of pixels above the descent to
 display the underline.
 @end table
 
index d2231bc278f21755197afef9d2bca314fe06a7fe..eb78521ea321c0df30b1ccfa8ce5f56825bcd76b 100644 (file)
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -444,21 +444,19 @@ Use 'TAB' in the minibuffer to show or hide the password.  Likewise,
 there is an icon on the mode-line, which toggles the visibility of the
 password when clicking with 'mouse-1'.
 
-** Terminal Emacs
++++
+** Support for styled underline face attributes.
+These are implemented as new values of the 'style' attribute in a face
+underline specification, 'double-line', 'dots', and 'dashes', and are
+available on GUI systems.  If your terminal's termcap or terminfo
+database entry defines the 'Su' or 'Smulx' capability, Emacs will also
+emit the prescribed escape sequence to render faces with such styles on
+TTY frames.
 
 ---
-*** Support for 'styled' and 'colored' underline face attributes on TTY frames.
-If your terminals termcap or terminfo database entry has the 'Su' or
-'Smulx' capability defined, Emacs will now emit the prescribed escape
-sequence necessary to render faces with styled underlines on TTY
-frames.
-
-Styled underlines are any underlines containing a non-default
-underline style or a color other than the foreground-color.
-The available underline styles for TTY frames are 'single',
-'double-line', 'wave', 'dots, and 'dashes'.  These are currently
-supported by Kitty, libvte, and st (through the undercurl patch) among
-other terminals.
+** Support for underline colors on TTY frames.
+Colors specified in face underlines will now also be displayed in TTY
+frames with the previously mentioned capabilities.
 
 \f
 * Editing Changes in Emacs 30.1