From unknown Mon Aug 18 15:40:22 2025 X-Loop: owner@emacsbugs.donarmstrong.com Subject: bug#4563: 23.1; Doc for partial completion and completion styles Reply-To: "Drew Adams" , 4563@debbugs.gnu.org Resent-From: "Drew Adams" Resent-To: bug-submit-list@lists.donarmstrong.com Resent-CC: Emacs Bugs 2Resent-Date: Sat, 26 Sep 2009 19:05:04 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-Emacs-PR-Message: report 4563 X-Emacs-PR-Package: emacs X-Emacs-PR-Keywords: Received: via spool by submit@emacsbugs.donarmstrong.com id=B.125399135129965 (code B ref -1); Sat, 26 Sep 2009 19:05:04 +0000 Received: (at submit) by emacsbugs.donarmstrong.com; 26 Sep 2009 18:55:51 +0000 X-Spam-Checker-Version: SpamAssassin 3.2.5-bugs.debian.org_2005_01_02 (2008-06-10) on rzlab.ucr.edu X-Spam-Level: X-Spam-Bayes: score:0.5 Bayes not run. spammytokens:Tokens not available. hammytokens:Tokens not available. X-Spam-Status: No, score=-2.4 required=4.0 tests=AWL,FOURLA autolearn=no version=3.2.5-bugs.debian.org_2005_01_02 Received: from lists.gnu.org (lists.gnu.org [199.232.76.165]) by rzlab.ucr.edu (8.14.3/8.14.3/Debian-5) with ESMTP id n8QItneo029960 for ; Sat, 26 Sep 2009 11:55:50 -0700 Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1MrcQv-0002bZ-BP for bug-gnu-emacs@gnu.org; Sat, 26 Sep 2009 14:55:49 -0400 Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1MrcQq-0002bL-0M for bug-gnu-emacs@gnu.org; Sat, 26 Sep 2009 14:55:48 -0400 Received: from [199.232.76.173] (port=35032 helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1MrcQp-0002bI-Ri for bug-gnu-emacs@gnu.org; Sat, 26 Sep 2009 14:55:43 -0400 Received: from acsinet12.oracle.com ([141.146.126.234]:34727) by monty-python.gnu.org with esmtps (TLS-1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.60) (envelope-from ) id 1MrcQp-0001h0-9P for bug-gnu-emacs@gnu.org; Sat, 26 Sep 2009 14:55:43 -0400 Received: from acsinet15.oracle.com (acsinet15.oracle.com [141.146.126.227]) by acsinet12.oracle.com (Switch-3.3.1/Switch-3.3.1) with ESMTP id n8QIsoZK018142 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for ; Sat, 26 Sep 2009 18:54:51 GMT Received: from abhmt006.oracle.com (abhmt006.oracle.com [141.146.116.15]) by acsinet15.oracle.com (Switch-3.3.1/Switch-3.3.1) with ESMTP id n8QIuEqa018901 for ; Sat, 26 Sep 2009 18:56:14 GMT Received: from dradamslap1 (/24.5.190.74) by default (Oracle Beehive Gateway v4.0) with ESMTP ; Sat, 26 Sep 2009 11:55:37 -0700 From: "Drew Adams" To: Date: Sat, 26 Sep 2009 11:55:42 -0700 Message-ID: <4D4314C09C1E40ABAAA7CA517FF82E8C@us.oracle.com> MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Mailer: Microsoft Office Outlook 11 Thread-Index: Aco+2vKVPaqaTLiqRGqT3SlmGwBf1Q== X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.5579 X-Source-IP: abhmt006.oracle.com [141.146.116.15] X-Auth-Type: Internal IP X-CT-RefId: str=0001.0A090209.4ABE63AA.01A7:SCFSTAT5015188,ss=1,fgs=0 X-detected-operating-system: by monty-python.gnu.org: GNU/Linux 2.6 (newer, 1) 1. In the Emacs manual, add index entries for the predefined completion styles: `basic', `partial-completion', `emacs22', and `emacs21'. Add index entries for partial completion (which covers more than the completion style `partial-completion'). 2. Node `Completion Commands' says that `*' matches any character. AFAICT, this is incorrect. Instead, it matches any sequence of characters (including an empty sequence). 3. The overall, default completion matching algorithm is described (in node `Completion Commands'), but there is nothing there that indicates which parts of this algorithm correspond to which parts of the default value of option `completion-styles'. There is thus no way for readers to know what the effect is of including `partial-completion' (for example) in `completion-styles'. That option is not even mentioned here, but it is central to the behavior of completion, which this node describes. There is no way for readers to know how to change the default completion behavior - there is not even a cross reference to node `Completion Options'. 4. The description in `Completion Commands' seems to imply that characters `-' and ` ' have an effect only when "partial completion" rules apply (presumably, that means when `partial-completion' is included in `completion-styles', but there is no explanation here of what "partial completion" is or what governs it). That's OK as far as it goes (those two chars), but the description in this node also seems to imply that `*' always has an effect, which is incorrect. AFAIK, `*' is part of the `partial-completion' style - if you remove that style from `completion-styles', then `*' does not have the effect described. The text covering `*' needs to be part of the discussion of partial completion, to reduce its apparent scope. 5. `completion-styles' needs better documentation. It is mentioned in node `Completion Options', but the description is not sufficient to help users. Each of the predefined completion styles needs to be described. For example, users should know what the effect is of including style `emacs22' or `partial-completion'. It is not enough to describe the overall effect of the default set of `completion-styles' - each style should be described, so that users can effectively customize `completion-styles'. That's the point of having a user option, and not simply hard-coding the behavior. 6. The doc string of `completion-styles' is inadequate in this regard also. It says simply "List of completion styles to use." In GNU Emacs 23.1.1 (i386-mingw-nt5.1.2600) of 2009-07-29 on SOFT-MJASON Windowing system distributor `Microsoft Corp.', version 5.1.2600 configured using `configure --with-gcc (4.4)' From unknown Mon Aug 18 15:40:22 2025 MIME-Version: 1.0 X-Mailer: MIME-tools 5.428 (Entity 5.428) X-Loop: help-debbugs@gnu.org From: help-debbugs@gnu.org (GNU bug Tracking System) To: "Drew Adams" Subject: bug#4563: closed (Re: 23.1; Doc for partial completion and completion styles) Message-ID: References: <87obtoh3w1.fsf@gnu.org> <4D4314C09C1E40ABAAA7CA517FF82E8C@us.oracle.com> X-Gnu-PR-Message: they-closed 4563 X-Gnu-PR-Package: emacs Reply-To: 4563@debbugs.gnu.org Date: Sat, 28 Jan 2012 04:03:01 +0000 Content-Type: multipart/mixed; boundary="----------=_1327723381-13821-1" This is a multi-part message in MIME format... ------------=_1327723381-13821-1 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Your bug report #4563: 23.1; Doc for partial completion and completion styles which was filed against the emacs package, has been closed. The explanation is attached below, along with your original report. If you require more details, please reply to 4563@debbugs.gnu.org. --=20 4563: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=3D4563 GNU Bug Tracking System Contact help-debbugs@gnu.org with problems ------------=_1327723381-13821-1 Content-Type: message/rfc822 Content-Disposition: inline Content-Transfer-Encoding: 7bit Received: (at 4563-done) by debbugs.gnu.org; 28 Jan 2012 04:02:08 +0000 Received: from localhost ([127.0.0.1]:47281 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from ) id 1RqzUO-0003Z1-1n for submit@debbugs.gnu.org; Fri, 27 Jan 2012 23:02:08 -0500 Received: from fencepost.gnu.org ([140.186.70.10]:37932 ident=Debian-exim) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from ) id 1RqzUM-0003Ys-08 for 4563-done@debbugs.gnu.org; Fri, 27 Jan 2012 23:02:06 -0500 Received: from bb121-7-229-168.singnet.com.sg ([121.7.229.168]:38668 helo=furball) by fencepost.gnu.org with esmtpsa (TLS1.0:DHE_RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1RqzTg-0006El-6i for 4563-done@debbugs.gnu.org; Fri, 27 Jan 2012 23:01:24 -0500 From: Chong Yidong To: 4563-done@debbugs.gnu.org Subject: Re: 23.1; Doc for partial completion and completion styles Date: Sat, 28 Jan 2012 12:01:18 +0800 Message-ID: <87obtoh3w1.fsf@gnu.org> MIME-Version: 1.0 Content-Type: text/plain X-Spam-Score: -4.2 (----) X-Debbugs-Envelope-To: 4563-done X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.13 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: debbugs-submit-bounces@debbugs.gnu.org Errors-To: debbugs-submit-bounces@debbugs.gnu.org X-Spam-Score: -4.2 (----) The documentation for completion styles has been completed in the trunk, so this bug report is out of date; closing. ------------=_1327723381-13821-1 Content-Type: message/rfc822 Content-Disposition: inline Content-Transfer-Encoding: 7bit Received: (at submit) by emacsbugs.donarmstrong.com; 26 Sep 2009 18:55:51 +0000 X-Spam-Checker-Version: SpamAssassin 3.2.5-bugs.debian.org_2005_01_02 (2008-06-10) on rzlab.ucr.edu X-Spam-Level: X-Spam-Bayes: score:0.5 Bayes not run. spammytokens:Tokens not available. hammytokens:Tokens not available. X-Spam-Status: No, score=-2.4 required=4.0 tests=AWL,FOURLA autolearn=no version=3.2.5-bugs.debian.org_2005_01_02 Received: from lists.gnu.org (lists.gnu.org [199.232.76.165]) by rzlab.ucr.edu (8.14.3/8.14.3/Debian-5) with ESMTP id n8QItneo029960 for ; Sat, 26 Sep 2009 11:55:50 -0700 Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1MrcQv-0002bZ-BP for bug-gnu-emacs@gnu.org; Sat, 26 Sep 2009 14:55:49 -0400 Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1MrcQq-0002bL-0M for bug-gnu-emacs@gnu.org; Sat, 26 Sep 2009 14:55:48 -0400 Received: from [199.232.76.173] (port=35032 helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1MrcQp-0002bI-Ri for bug-gnu-emacs@gnu.org; Sat, 26 Sep 2009 14:55:43 -0400 Received: from acsinet12.oracle.com ([141.146.126.234]:34727) by monty-python.gnu.org with esmtps (TLS-1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.60) (envelope-from ) id 1MrcQp-0001h0-9P for bug-gnu-emacs@gnu.org; Sat, 26 Sep 2009 14:55:43 -0400 Received: from acsinet15.oracle.com (acsinet15.oracle.com [141.146.126.227]) by acsinet12.oracle.com (Switch-3.3.1/Switch-3.3.1) with ESMTP id n8QIsoZK018142 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for ; Sat, 26 Sep 2009 18:54:51 GMT Received: from abhmt006.oracle.com (abhmt006.oracle.com [141.146.116.15]) by acsinet15.oracle.com (Switch-3.3.1/Switch-3.3.1) with ESMTP id n8QIuEqa018901 for ; Sat, 26 Sep 2009 18:56:14 GMT Received: from dradamslap1 (/24.5.190.74) by default (Oracle Beehive Gateway v4.0) with ESMTP ; Sat, 26 Sep 2009 11:55:37 -0700 From: "Drew Adams" To: Subject: 23.1; Doc for partial completion and completion styles Date: Sat, 26 Sep 2009 11:55:42 -0700 Message-ID: <4D4314C09C1E40ABAAA7CA517FF82E8C@us.oracle.com> MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Mailer: Microsoft Office Outlook 11 Thread-Index: Aco+2vKVPaqaTLiqRGqT3SlmGwBf1Q== X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.5579 X-Source-IP: abhmt006.oracle.com [141.146.116.15] X-Auth-Type: Internal IP X-CT-RefId: str=0001.0A090209.4ABE63AA.01A7:SCFSTAT5015188,ss=1,fgs=0 X-detected-operating-system: by monty-python.gnu.org: GNU/Linux 2.6 (newer, 1) 1. In the Emacs manual, add index entries for the predefined completion styles: `basic', `partial-completion', `emacs22', and `emacs21'. Add index entries for partial completion (which covers more than the completion style `partial-completion'). 2. Node `Completion Commands' says that `*' matches any character. AFAICT, this is incorrect. Instead, it matches any sequence of characters (including an empty sequence). 3. The overall, default completion matching algorithm is described (in node `Completion Commands'), but there is nothing there that indicates which parts of this algorithm correspond to which parts of the default value of option `completion-styles'. There is thus no way for readers to know what the effect is of including `partial-completion' (for example) in `completion-styles'. That option is not even mentioned here, but it is central to the behavior of completion, which this node describes. There is no way for readers to know how to change the default completion behavior - there is not even a cross reference to node `Completion Options'. 4. The description in `Completion Commands' seems to imply that characters `-' and ` ' have an effect only when "partial completion" rules apply (presumably, that means when `partial-completion' is included in `completion-styles', but there is no explanation here of what "partial completion" is or what governs it). That's OK as far as it goes (those two chars), but the description in this node also seems to imply that `*' always has an effect, which is incorrect. AFAIK, `*' is part of the `partial-completion' style - if you remove that style from `completion-styles', then `*' does not have the effect described. The text covering `*' needs to be part of the discussion of partial completion, to reduce its apparent scope. 5. `completion-styles' needs better documentation. It is mentioned in node `Completion Options', but the description is not sufficient to help users. Each of the predefined completion styles needs to be described. For example, users should know what the effect is of including style `emacs22' or `partial-completion'. It is not enough to describe the overall effect of the default set of `completion-styles' - each style should be described, so that users can effectively customize `completion-styles'. That's the point of having a user option, and not simply hard-coding the behavior. 6. The doc string of `completion-styles' is inadequate in this regard also. It says simply "List of completion styles to use." In GNU Emacs 23.1.1 (i386-mingw-nt5.1.2600) of 2009-07-29 on SOFT-MJASON Windowing system distributor `Microsoft Corp.', version 5.1.2600 configured using `configure --with-gcc (4.4)' ------------=_1327723381-13821-1--