From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#57080: 29.0.60; [PATCH] Updates to mode line construct documentation (was: The %m modeline construct does not work for emacs-lisp-mode) Date: Sat, 18 Mar 2023 09:46:54 +0200 Message-ID: <834jqicxht.fsf@gnu.org> References: <1A5F4673-FA9C-4E23-A0C1-5125764E0EE7@gmail.com> <83v8r1tlgy.fsf@gnu.org> <83o7wttkha.fsf@gnu.org> <83h72kstxb.fsf@gnu.org> <8f76c5fd3cf4bda02f9b55c3df55a47c@webmail.orcon.net.nz> <87bdaf86c1edac42a5c004c14364608b@webmail.orcon.net.nz> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="38527"; mail-complaints-to="usenet@ciao.gmane.io" Cc: diredwolf1@gmail.com, 57080@debbugs.gnu.org To: Phil Sainty Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sat Mar 18 08:48:15 2023 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1pdRIV-0009nV-Kx for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 18 Mar 2023 08:48:15 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pdRIL-000678-Am; Sat, 18 Mar 2023 03:48:05 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pdRIK-00066k-48 for bug-gnu-emacs@gnu.org; Sat, 18 Mar 2023 03:48:04 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1pdRII-0002PT-In for bug-gnu-emacs@gnu.org; Sat, 18 Mar 2023 03:48:03 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1pdRII-0003mK-F6 for bug-gnu-emacs@gnu.org; Sat, 18 Mar 2023 03:48:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 18 Mar 2023 07:48:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 57080 X-GNU-PR-Package: emacs Original-Received: via spool by 57080-submit@debbugs.gnu.org id=B57080.167912562214296 (code B ref 57080); Sat, 18 Mar 2023 07:48:02 +0000 Original-Received: (at 57080) by debbugs.gnu.org; 18 Mar 2023 07:47:02 +0000 Original-Received: from localhost ([127.0.0.1]:46107 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pdRHJ-0003iV-La for submit@debbugs.gnu.org; Sat, 18 Mar 2023 03:47:02 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:33748) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pdRHH-0003hz-Gv for 57080@debbugs.gnu.org; Sat, 18 Mar 2023 03:47:00 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pdRHB-00022D-17; Sat, 18 Mar 2023 03:46:53 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=I2tDmOFAv+4iynMd8G3i4455dYcjla1vbo/d8CT50gI=; b=nGEk6ID3WiyP 388Lj2+LUWbrcP0HmRXS83tEJCs0x3nUGX74diC22wKdJhkj3754AFcPGrrvmKCUUy/a825ExUkHt +j8rwsBXTKugIuvQy8wLvOpfcPaNrjK3YIAx8zEKsnrqNSuyGrKwPPQ6ssFKnh1prD2I2uDHrxLYb meCxsZezb5K3SNj2g6tWj6zst8OoUQi6yz2wFOGdyiHJXh9GZsWL33sWOFcA0NOFVUIfXPKl4mZo5 3MRtAae4FFxc0DcRHL/wBetl9lz0oHZiD42hTRTRJbKrMGcky+tC4xtURUOp2PO72aPH246X5u0pI uIyjjTkDk5S4CLPFXIyM6w==; Original-Received: from [87.69.77.57] (helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pdRH9-0007Sf-O5; Sat, 18 Mar 2023 03:46:52 -0400 In-Reply-To: <87bdaf86c1edac42a5c004c14364608b@webmail.orcon.net.nz> (message from Phil Sainty on Sat, 18 Mar 2023 20:22:24 +1300) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:258136 Archived-At: > Date: Sat, 18 Mar 2023 20:22:24 +1300 > From: Phil Sainty > Cc: diredwolf1@gmail.com, 57080@debbugs.gnu.org > > Does anyone object to me merging branch > fix/bug-57080-mode-line-format-docs > ( https://lists.gnu.org/archive/html/emacs-diffs/2023-03/msg00453.html ) > to the emacs-29 branch? It goes too far, IMO, see below. > It addresses the issue from this bug along with several related things > that I found in the process of looking at that. > > * The %m documentation was not entirely accurate (as discussed here). But you moved it from its place near the end of the node (as appropriate for obsolete features) to the mainline. Why not leave it where it was, and just add the explanation why its usage is not advised? > * The %M documentation was also not up to date. > * The %t construct was obsolete but still documented. So let's move %t to where %m is. > * The %o and %q constructs were lacking documentation. In the manual? I don't see them being added there. > * The `mode-line-format' docstring for all of the constructs was > not as easy to read as it could have been. I would leave this part alone on emacs-29, and only install the reformatting of the doc string on master. > The final reformatting of the `mode-line-format' docstring sorts the > constructs by letter (which makes everything easier to find); eliminates > multiple constructs being crammed into single lines (which also makes > everything easier to find); and rephrases some things for (IMHO) easier > readability and comprehension. It also makes the text taller, thus requiring a larger Help window. Is it still reasonably readable in "emacs -Q"? Anyway, I think this part is for master. > I untabified the indentation, as that didn't render correctly with a > tab-width of anything other than 8, which might be a problem for other > docstrings as well. Should help-mode set tab-width to 8 ?? tab-width is a user variable, so no Lisp program should set it, IMO. Bottom line: . I'm okay with manual changes, modulo the movement of %m -- it should stay where it was. . I'm okay with adding %t to the manual (in the "obsolete" part). . I'm okay with removing %t from the doc string. . I'm okay with fixing the doc string of global-mode-string. . All the rest is okay for master. Thanks.