From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: "Drew Adams" Newsgroups: gmane.emacs.bugs Subject: bug#8935: 24.0.50; `substitute-command-keys' doc Date: Fri, 15 Jul 2011 12:17:46 -0700 Message-ID: <52B42160EFF24B69AE5BBAC0A0D03346@us.oracle.com> References: <7A4E77E7DAE2436DA3DFE76693103500@us.oracle.com> NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Trace: dough.gmane.org 1310757571 28096 80.91.229.12 (15 Jul 2011 19:19:31 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Fri, 15 Jul 2011 19:19:31 +0000 (UTC) Cc: 8935@debbugs.gnu.org To: "'Andreas Schwab'" , "'Lars Magne Ingebrigtsen'" Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Fri Jul 15 21:19:27 2011 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([140.186.70.17]) by lo.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1Qhnv4-00056y-59 for geb-bug-gnu-emacs@m.gmane.org; Fri, 15 Jul 2011 21:19:26 +0200 Original-Received: from localhost ([::1]:48367 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Qhnv2-0003Jl-Tq for geb-bug-gnu-emacs@m.gmane.org; Fri, 15 Jul 2011 15:19:25 -0400 Original-Received: from eggs.gnu.org ([140.186.70.92]:45498) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Qhnui-0003JF-9p for bug-gnu-emacs@gnu.org; Fri, 15 Jul 2011 15:19:05 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Qhnug-0008Ov-N3 for bug-gnu-emacs@gnu.org; Fri, 15 Jul 2011 15:19:04 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:48501) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Qhnug-0008Oq-7E for bug-gnu-emacs@gnu.org; Fri, 15 Jul 2011 15:19:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.69) (envelope-from ) id 1Qhnuf-0005Zu-Q3; Fri, 15 Jul 2011 15:19:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: "Drew Adams" Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-To: owner@debbugs.gnu.org Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 15 Jul 2011 19:19:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 8935 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: fixed Original-Received: via spool by 8935-submit@debbugs.gnu.org id=B8935.131075748721376 (code B ref 8935); Fri, 15 Jul 2011 19:19:01 +0000 Original-Received: (at 8935) by debbugs.gnu.org; 15 Jul 2011 19:18:07 +0000 Original-Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1Qhntn-0005Yj-DU for submit@debbugs.gnu.org; Fri, 15 Jul 2011 15:18:07 -0400 Original-Received: from acsinet15.oracle.com ([141.146.126.227]) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1Qhntl-0005YH-MB for 8935@debbugs.gnu.org; Fri, 15 Jul 2011 15:18:06 -0400 Original-Received: from acsinet21.oracle.com (acsinet21.oracle.com [141.146.126.237]) by acsinet15.oracle.com (Switch-3.4.4/Switch-3.4.4) with ESMTP id p6FJHv5S016539 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Fri, 15 Jul 2011 19:17:59 GMT Original-Received: from acsmt357.oracle.com (acsmt357.oracle.com [141.146.40.157]) by acsinet21.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id p6FJHuSJ022473 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO); Fri, 15 Jul 2011 19:17:57 GMT Original-Received: from abhmt119.oracle.com (abhmt119.oracle.com [141.146.116.71]) by acsmt357.oracle.com (8.12.11.20060308/8.12.11) with ESMTP id p6FJHo9l018524; Fri, 15 Jul 2011 14:17:51 -0500 Original-Received: from dradamslap1 (/10.159.40.132) by default (Oracle Beehive Gateway v4.0) with ESMTP ; Fri, 15 Jul 2011 12:17:50 -0700 X-Mailer: Microsoft Office Outlook 11 In-Reply-To: Thread-Index: AcxDHnIkGz8tMq+USOS9NpiBMqJnhQAA9/Ug X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.6109 X-Source-IP: acsinet21.oracle.com [141.146.126.237] X-Auth-Type: Internal IP X-CT-RefId: str=0001.0A090208.4E209267.0151:SCFMA922111,ss=1,re=-4.000,fgs=0 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list Resent-Date: Fri, 15 Jul 2011 15:19:01 -0400 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 3) X-Received-From: 140.186.70.43 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.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:49205 Archived-At: > > "\=\e" will print as "\e"? Right? So it's not a noop, and the fix I > > applied was correct. > > No. The *only* special sequences processed by > substitute-command-keys' are '\=', '\[', '\<' and '\{'. > Nothing else. Correct. > The sentence is about how to write these special sequences in > the doc string so that they are not treated specially, Correct. > so the examples should talk about '\=' and '\[', not about '\'. It's OK to mention that in "\=\[" the \= escapes the \ so that \[ appears in the output. But it is only the \ that is being escaped here. Escaping a character means making it act normally, not specially. Only the \ acts specially, and it does so only when it precedes [, {, etc. So yes, this escaping of \ only has an effect when the \ precedes [, {, etc. But strictly speaking it is only the \ that gets escaped in these contexts. The =, [, etc. does not need to be escaped because those are not treated specially unless preceded by an unescaped \. So only one character needs to be escaped: the \. Anyway, it's a minor point (bug). I really don't care what you do with it. When I read the doc string, I found it confusing. I looked at the code and understood. It is _enough_ to say that \= escapes a \, preventing it from introducing a substitution when followed by =, [, etc. Or as I said in the beginning: > This is uncessarily complex and misleading. All the `\=' does is > quote/escape the (single) next character, whatever it is. Nothing > more.