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#66303: [PATCH] Document 'M-x align' in the Emacs manual Date: Sat, 14 Oct 2023 11:00:50 +0300 Message-ID: <83fs2dskel.fsf@gnu.org> References: <83wmw56md7.fsf@gnu.org> <83edi94ic9.fsf@gnu.org> <83bkda28rr.fsf@gnu.org> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="21937"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 66303@debbugs.gnu.org To: Eshel Yaron Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sat Oct 14 10:02:07 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 1qrZb4-0005Pk-Jw for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 14 Oct 2023 10:02:06 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qrZag-0006Oe-MM; Sat, 14 Oct 2023 04:01:42 -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 1qrZad-0006OM-71 for bug-gnu-emacs@gnu.org; Sat, 14 Oct 2023 04:01:39 -0400 Original-Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1qrZac-0000PG-V4 for bug-gnu-emacs@gnu.org; Sat, 14 Oct 2023 04:01:38 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1qrZb0-0006HN-3w for bug-gnu-emacs@gnu.org; Sat, 14 Oct 2023 04:02: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, 14 Oct 2023 08:02:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 66303 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 66303-submit@debbugs.gnu.org id=B66303.169727048524090 (code B ref 66303); Sat, 14 Oct 2023 08:02:02 +0000 Original-Received: (at 66303) by debbugs.gnu.org; 14 Oct 2023 08:01:25 +0000 Original-Received: from localhost ([127.0.0.1]:47800 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qrZaO-0006GR-K8 for submit@debbugs.gnu.org; Sat, 14 Oct 2023 04:01:25 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:53474) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qrZaL-0006GC-Sn for 66303@debbugs.gnu.org; Sat, 14 Oct 2023 04:01:23 -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 1qrZZs-0000Gd-QF; Sat, 14 Oct 2023 04:00:52 -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=j3L87aEKxrWbaGj97s3y8QMl1tmdufsKwYmG2IVaNHo=; b=J+9T43X0dpe7 ET+xNN40CJWFSCkgpGZEnflcn+bdXFCSZT1cLzRdgiJYGbN3jdsrLkMFBSckJWBd50d9J5aB0RAm+ BXF4Nr5nGAMVLg4VB84+tykB3u3ZEkKVv8kmPSwKp1x4iAuEZ7LtS2A5rq6q8EDsWrE9eGRTO+vjz XjGZCJGVlDCM2dRpe4SjKMMne0Le8Fyp/rC+bKf8q6Rb0GuQM9tSYySTlg89utJXZ7kg0a3ED7JSx RlUbB/BOI6FHTJBUpEIVBe8s7oUqOKACRhDMFAYluaidynI+FaJ2TWnKW+1vEADtu/JPmizXz6og3 rIT0X2DE8DJPYxG5YeBHoQ==; In-Reply-To: (message from Eshel Yaron on Sat, 07 Oct 2023 21:02:19 +0200) 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:272387 Archived-At: > From: Eshel Yaron > Cc: 66303@debbugs.gnu.org > Date: Sat, 07 Oct 2023 21:02:19 +0200 > > New patch: Thanks. I have a couple of minor issues, and then we can install this: > +@findex align > + You can use the command @kbd{M-x align} to align lines in the > +current region. This command knows about common alignment patterns > +across many markup and programming languages. It encodes these > +patterns as a set of @dfn{alignment rules}, that say how to align > +different kinds of text in different contexts. Whenever you use @dfn, you introduce new terminology. New terminology should always be indexed, so that readers could easily find its description. So for the above paragraph there should be @cindex alignment rules. > +@vindex align-exclude-rules-list > +@vindex align-mode-exclude-rules-list > +Besides alignment rules, @kbd{M-x align} uses another kind of rules > +called @dfn{exclusion rules}. The exclusion rules say which parts in > +the region @kbd{M-x align} should not align and instead leave them > +intact. The user option @code{align-exclude-rules-list} specifies And here we should have @cindex align exclusion rules > +@findex align-regexp > + The command @kbd{M-x align-regexp} lets you align the current region > +with an alignment rule that you define ad-hoc, instead of using the > +predefined rules in @code{align-rules-list}. @kbd{M-x align-regexp} > +prompts you for a regular expression and uses that expression as the > +@code{regexp} attribute for an ad-hoc alignment rule that this command > +uses to align the current region. By default, this command adjusts > +the whitespace that matches the first sub-expression of the regular > +expression you specify. If you call @kbd{M-x align-regexp} with a Here and elsewhere you mention regexp sub-expressions. Please add in those places a cross-reference to where sub-expressions are described in the manual, since this is an advanced aspect of regexps with which some readers might not be well acquainted.