]> git.eshelyaron.com Git - emacs.git/commitdiff
; Improve doc strings of 'tab-bar-mode' and 'tab-line-mode'
authorEli Zaretskii <eliz@gnu.org>
Thu, 5 Sep 2024 19:09:40 +0000 (22:09 +0300)
committerEshel Yaron <me@eshelyaron.com>
Sun, 8 Sep 2024 11:22:48 +0000 (13:22 +0200)
* lisp/tab-line.el (tab-line-mode):
* lisp/tab-bar.el (tab-bar-mode): Doc fixes (bug#73049)

(cherry picked from commit 54071b9cef287ac6826d67534d0c5c935bbca78c)

lisp/tab-bar.el
lisp/tab-line.el

index f8c49f5598acc7239aae87e011c78542ae159fb1..88b45114f4d5dca1f05dc8c7da2a37fefe3eb0a3 100644 (file)
@@ -257,7 +257,15 @@ a list of frames to update."
   "Tab Bar mode map.")
 
 (define-minor-mode tab-bar-mode
-  "Toggle the tab bar in all graphical frames (Tab Bar mode)."
+  "Toggle the tab bar in all graphical frames (Tab Bar mode).
+
+When this mode is enabled, Emacs displays a tab bar on top of each frame.
+The tab bar is a row of tabs -- buttons that you can click
+to switch the frame between different window configurations.
+See `current-window-configuration' for more about window configurations.
+To add a button (which can then record one more window configuration),
+click on the \"+\" button.  Clicking on the \"x\" icon of a button
+deletes the button."
   :global t
   ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
   :variable tab-bar-mode
index 462a0a27692e2bd9a76f17c454344198979536d8..92b52b6936c5142ea6dd065b08bd364895376e9c 100644 (file)
@@ -1141,7 +1141,15 @@ However, return the correct mouse position list if EVENT is a
 
 ;;;###autoload
 (define-minor-mode tab-line-mode
-  "Toggle display of tab line in the windows displaying the current buffer."
+  "Toggle display of tab line in the windows displaying the current buffer.
+
+When this mode is enabled, each window displays a tab line on its
+top screen line.  The tab line is a row of tabs -- buttons which
+you can click to have the window display the buffer whose name is
+shown on the button.  Clicking on the \"x\" icon of the button
+removes the button (but does not kill the corresponding buffer).
+In addition, the tab line shows a \"+\" button which adds a new
+button, so you could have one more buffer shown on the tab line."
   :lighter nil
   (let ((default-value '(:eval (tab-line-format))))
     ;; Preserve the existing tab-line set outside of this mode