GNU bug report logs - #25195
25.1; Index backslash for escape of left-margin paren

Previous Next

Package: emacs;

Reported by: Drew Adams <drew.adams <at> oracle.com>

Date: Tue, 13 Dec 2016 21:05:01 UTC

Severity: wishlist

Tags: fixed

Found in version 25.1

Fixed in version 26.3

Done: Noam Postavsky <npostavs <at> gmail.com>

Bug is archived. No further changes may be made.

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 25195 in the body.
You can then email your comments to 25195 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

View this report as an mbox folder, status mbox, maintainer mbox


Report forwarded to bug-gnu-emacs <at> gnu.org:
bug#25195; Package emacs. (Tue, 13 Dec 2016 21:05:02 GMT) Full text and rfc822 format available.

Acknowledgement sent to Drew Adams <drew.adams <at> oracle.com>:
New bug report received and forwarded. Copy sent to bug-gnu-emacs <at> gnu.org. (Tue, 13 Dec 2016 21:05:02 GMT) Full text and rfc822 format available.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Drew Adams <drew.adams <at> oracle.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 25.1; Index backslash for escape of left-margin paren
Date: Tue, 13 Dec 2016 13:04:36 -0800 (PST)
The Emacs manual, node `Left Margin Convention', seems to be the only
place that the convention of a paren in column 0 is documented.  The
backslash escaping is not indexed however - it should be.

It should also be documented in the Elisp manual, I think.  And so
should the similar escaping of a column-zero paren or bracket in a doc
string.  I could not find any mention of this.  And again, doc of these
features should be indexed under backslash escaping.

In GNU Emacs 25.1.1 (x86_64-w64-mingw32)
 of 2016-09-17 built on LAPHROAIG
Windowing system distributor 'Microsoft Corp.', version 6.1.7601
Configured using:
 'configure --without-dbus --without-compress-install CFLAGS=-static'




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#25195; Package emacs. (Sat, 27 Jul 2019 11:22:01 GMT) Full text and rfc822 format available.

Message #8 received at 25195 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 25195 <at> debbugs.gnu.org
Subject: Re: bug#25195: 25.1; Index backslash for escape of left-margin paren
Date: Sat, 27 Jul 2019 13:21:19 +0200
Drew Adams <drew.adams <at> oracle.com> writes:

> The Emacs manual, node `Left Margin Convention', seems to be the only
> place that the convention of a paren in column 0 is documented.  The
> backslash escaping is not indexed however - it should be.

Hm...  Well, it does say that if you have a parent in column 0, then
it's treated specially.  If you have

"bla bla
\(foo bar)"

then the ( isn't in column zero, and \( => ( in this context.

So I'm not sure this is even a convention; it's just a work-around.  And
what character to use in what language to get a similar effect is surely
language-dependent?

So I don't think this is something that needs expounding upon; closing.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no




Added tag(s) wontfix. Request was from Lars Ingebrigtsen <larsi <at> gnus.org> to control <at> debbugs.gnu.org. (Sat, 27 Jul 2019 11:22:02 GMT) Full text and rfc822 format available.

bug closed, send any further explanations to 25195 <at> debbugs.gnu.org and Drew Adams <drew.adams <at> oracle.com> Request was from Lars Ingebrigtsen <larsi <at> gnus.org> to control <at> debbugs.gnu.org. (Sat, 27 Jul 2019 11:22:02 GMT) Full text and rfc822 format available.

Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#25195; Package emacs. (Sat, 27 Jul 2019 16:14:02 GMT) Full text and rfc822 format available.

Message #15 received at 25195 <at> debbugs.gnu.org (full text, mbox):

From: Drew Adams <drew.adams <at> oracle.com>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: 25195 <at> debbugs.gnu.org
Subject: RE: bug#25195: 25.1; Index backslash for escape of left-margin paren
Date: Sat, 27 Jul 2019 09:13:25 -0700 (PDT)
> > The Emacs manual, node `Left Margin Convention', seems to be the only
> > place that the convention of a paren in column 0 is documented.  The
> > backslash escaping is not indexed however - it should be.
> 
> Hm...  Well, it does say that if you have a parent in column 0, then
> it's treated specially.  If you have
> 
> "bla bla
> \(foo bar)"
> 
> then the ( isn't in column zero, and \( => ( in this context.
> 
> So I'm not sure this is even a convention; it's just a work-around.
> And what character to use in what language to get a similar effect is
> surely language-dependent?
> 
> So I don't think this is something that needs expounding upon; closing.

(I should have said mode `Left Margin Paren'.
The title of the node is "Left Margin Convention".)

I don't understand what you're saying.

If you have a paren in column 0 then you need to
escape it, to make indentation, movement etc.
work well.

What's not a convention about that (see the title)?
But what difference does it make if you prefer to
see it as a workaround.  Users need to know about
it, which is why we document it.

And it's why we font-lock delimiters "that ought
to be quoted".  ("Ought" is a strong word, showing
that this is indeed intended as a convention.)

And it's why we have a variable to inhibit the need
for such escaping - also documented in this node.

And it's not just for a paren - same thing for other
delimiters.  E.g., in Elisp a (square) bracket.





Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#25195; Package emacs. (Sat, 27 Jul 2019 16:37:02 GMT) Full text and rfc822 format available.

Message #18 received at 25195 <at> debbugs.gnu.org (full text, mbox):

From: Noam Postavsky <npostavs <at> gmail.com>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: 25195 <at> debbugs.gnu.org, Drew Adams <drew.adams <at> oracle.com>
Subject: Re: bug#25195: 25.1; Index backslash for escape of left-margin paren
Date: Sat, 27 Jul 2019 12:36:22 -0400
Lars Ingebrigtsen <larsi <at> gnus.org> writes:

> So I don't think this is something that needs expounding upon; closing.

I don't we need to "expound" on anything, the report just asks about
indexing.  So with something like the diff below, if someone sees 

"bla bla
\(foo bar)"

And they wonder "what's that \( thing for?", they could do i \( RET to
find the right spot in the manual.

--- i/doc/emacs/programs.texi
+++ w/doc/emacs/programs.texi
@@ -180,6 +180,7 @@ Left Margin Paren
 affect the contents of the string, but will prevent that opening
 delimiter from starting a defun.  Here's an example:
 
+@cindex \( in strings
 @example
   (insert "Foo:
 \(bar)




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#25195; Package emacs. (Sun, 28 Jul 2019 09:46:01 GMT) Full text and rfc822 format available.

Message #21 received at 25195 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Noam Postavsky <npostavs <at> gmail.com>
Cc: 25195 <at> debbugs.gnu.org, Drew Adams <drew.adams <at> oracle.com>
Subject: Re: bug#25195: 25.1; Index backslash for escape of left-margin paren
Date: Sun, 28 Jul 2019 11:45:02 +0200
Noam Postavsky <npostavs <at> gmail.com> writes:

> I don't we need to "expound" on anything, the report just asks about
> indexing.  So with something like the diff below, if someone sees 
>
> "bla bla
> \(foo bar)"
>
> And they wonder "what's that \( thing for?", they could do i \( RET to
> find the right spot in the manual.

Makes sense; please apply.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#25195; Package emacs. (Tue, 30 Jul 2019 13:21:02 GMT) Full text and rfc822 format available.

Message #24 received at 25195 <at> debbugs.gnu.org (full text, mbox):

From: Noam Postavsky <npostavs <at> gmail.com>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: 25195 <at> debbugs.gnu.org, Drew Adams <drew.adams <at> oracle.com>
Subject: Re: bug#25195: 25.1; Index backslash for escape of left-margin paren
Date: Tue, 30 Jul 2019 09:20:13 -0400
tags 25195 = fixed
close 25195 26.3
quit

Lars Ingebrigtsen <larsi <at> gnus.org> writes:

> Noam Postavsky <npostavs <at> gmail.com> writes:
>
>> I don't we need to "expound" on anything, the report just asks about
>> indexing.  So with something like the diff below, if someone sees 
>>
>> "bla bla
>> \(foo bar)"
>>
>> And they wonder "what's that \( thing for?", they could do i \( RET to
>> find the right spot in the manual.
>
> Makes sense; please apply.

Done in emacs-26; I added an xref in the elisp manual too.

1d9efc0b3a 2019-07-30T09:06:18-04:00 "Add index for "\( in strings" (Bug#25195)"
https://git.savannah.gnu.org/cgit/emacs.git/commit/?id=1d9efc0b3a60fda86885001b229b6528ffb931df





Added tag(s) fixed; removed tag(s) wontfix. Request was from Noam Postavsky <npostavs <at> gmail.com> to control <at> debbugs.gnu.org. (Tue, 30 Jul 2019 13:21:02 GMT) Full text and rfc822 format available.

bug marked as fixed in version 26.3, send any further explanations to 25195 <at> debbugs.gnu.org and Drew Adams <drew.adams <at> oracle.com> Request was from Noam Postavsky <npostavs <at> gmail.com> to control <at> debbugs.gnu.org. (Tue, 30 Jul 2019 13:21:03 GMT) Full text and rfc822 format available.

Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#25195; Package emacs. (Tue, 30 Jul 2019 19:11:02 GMT) Full text and rfc822 format available.

Message #31 received at 25195 <at> debbugs.gnu.org (full text, mbox):

From: Drew Adams <drew.adams <at> oracle.com>
To: Noam Postavsky <npostavs <at> gmail.com>, Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: 25195 <at> debbugs.gnu.org
Subject: RE: bug#25195: 25.1; Index backslash for escape of left-margin paren
Date: Tue, 30 Jul 2019 12:10:18 -0700 (PDT)
> Done in emacs-26; I added an xref in the elisp manual too.

Thanks.  That helps.




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#25195; Package emacs. (Wed, 31 Jul 2019 04:53:01 GMT) Full text and rfc822 format available.

Message #34 received at 25195 <at> debbugs.gnu.org (full text, mbox):

From: Glenn Morris <rgm <at> gnu.org>
To: Noam Postavsky <npostavs <at> gmail.com>
Cc: 25195 <at> debbugs.gnu.org, Lars Ingebrigtsen <larsi <at> gnus.org>
Subject: Re: bug#25195: 25.1; Index backslash for escape of left-margin paren
Date: Wed, 31 Jul 2019 00:52:29 -0400
> 1d9efc0b3a 2019-07-30T09:06:18-04:00 "Add index for "\( in strings" (Bug#25195)"
> https://git.savannah.gnu.org/cgit/emacs.git/commit/?id=1d9efc0b3a60fda86885001b229b6528ffb931df

The doc/emacs index cannot be merged to master owing to aead21d.
The doc/lispref change did merge, but is perhaps no longer relevant
owing to the same.




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#25195; Package emacs. (Wed, 31 Jul 2019 12:38:01 GMT) Full text and rfc822 format available.

Message #37 received at 25195 <at> debbugs.gnu.org (full text, mbox):

From: Noam Postavsky <npostavs <at> gmail.com>
To: Glenn Morris <rgm <at> gnu.org>
Cc: 25195 <at> debbugs.gnu.org, Lars Ingebrigtsen <larsi <at> gnus.org>
Subject: Re: bug#25195: 25.1; Index backslash for escape of left-margin paren
Date: Wed, 31 Jul 2019 08:37:45 -0400
Glenn Morris <rgm <at> gnu.org> writes:

>> 1d9efc0b3a 2019-07-30T09:06:18-04:00 "Add index for "\( in strings" (Bug#25195)"
>> https://git.savannah.gnu.org/cgit/emacs.git/commit/?id=1d9efc0b3a60fda86885001b229b6528ffb931df
>
> The doc/emacs index cannot be merged to master owing to aead21d.
> The doc/lispref change did merge, but is perhaps no longer relevant
> owing to the same.

Oh, forgot about that.  I think index in lispref is okay, I just removed
the xref.

0aa4bfaab8 2019-07-31T08:33:28-04:00 "Remove no-longer relevant xref"
https://git.savannah.gnu.org/cgit/emacs.git/commit/?id=0aa4bfaab8f7452ad1c972e60e3e0745fa16f9b6





bug archived. Request was from Debbugs Internal Request <help-debbugs <at> gnu.org> to internal_control <at> debbugs.gnu.org. (Thu, 29 Aug 2019 11:24:05 GMT) Full text and rfc822 format available.

This bug report was last modified 4 years and 213 days ago.

Previous Next


GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.