GNU bug report logs - #15006
24.3; emacs manual comment-start-skip example grouping

Previous Next

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

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

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

From: Kevin Ryde <user42 <at> zip.com.au>
To: bug-gnu-emacs <at> gnu.org
Subject: 24.3; emacs manual comment-start-skip example grouping
Date: Fri, 02 Aug 2013 10:48:36 +1000

In the emacs manual info node "(emacs)Options for Comments" an example
comment-start-skip is given

    "\\(//+\\|/\\*+\\)\\s *"

If I understand the comment-start-skip docstring correctly a \(..\)
group is for extra distinguishing text preceding the comment.  Should
that example be a shy group, or perhaps expanded out to ungroup like
vera-mode.el has?

    "/\\*+ *\\|//+ *"

I also wondered whether the whitespace "\\s *" in the example was a
little too loose since it matches \n and leading whitespace of the next
line too.  Does that matter to anything?



In GNU Emacs 24.3.1 (i486-pc-linux-gnu, X toolkit, Xaw3d scroll bars)
 of 2013-05-29 on blah.blah, modified by Debian
System Description:	Debian GNU/Linux 7.0 (wheezy)

Configured using:
 `configure '--build' 'i486-linux-gnu' '--build' 'i486-linux-gnu'
 '--prefix=/usr' '--sharedstatedir=/var/lib' '--libexecdir=/usr/lib'
 '--localstatedir=/var/lib' '--infodir=/usr/share/info'
 '--mandir=/usr/share/man' '--with-pop=yes'
 '--enable-locallisppath=/etc/emacs24:/etc/emacs:/usr/local/share/emacs/24.3/site-lisp:/usr/local/share/emacs/site-lisp:/usr/share/emacs/24.3/site-lisp:/usr/share/emacs/site-lisp'
 '--with-crt-dir=/usr/lib/i386-linux-gnu' '--with-x=yes'
 '--with-x-toolkit=lucid' '--with-toolkit-scroll-bars' '--without-gconf'
 'build_alias=i486-linux-gnu' 'CFLAGS=-g -O2 -fstack-protector
 --param=ssp-buffer-size=4 -Wformat -Werror=format-security -Wall'
 'LDFLAGS=-Wl,-z,relro -Wl,-znocombreloc'
 'CPPFLAGS=-D_FORTIFY_SOURCE=2''

Important settings:
  value of $LANG: en_AU
  locale-coding-system: iso-latin-1-unix
  default enable-multibyte-characters: t

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

From: Stefan Monnier <monnier <at> iro.umontreal.ca>
To: Kevin Ryde <user42 <at> zip.com.au>
Cc: 15006 <at> debbugs.gnu.org
Subject: Re: bug#15006: 24.3; emacs manual comment-start-skip example grouping
Date: Thu, 01 Aug 2013 21:34:57 -0400

> If I understand the comment-start-skip docstring correctly a \(..\)
> group is for extra distinguishing text preceding the comment.  Should
> that example be a shy group,

Indeed, thank you.

> I also wondered whether the whitespace "\\s *" in the example was a
> little too loose since it matches \n and leading whitespace of the next
> line too.  Does that matter to anything?

Yes, I prefer to stay away from "whitepace syntax" for that reason and
would recommend [ \t]* in its stead.


        Stefan

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

From: Kevin Ryde <user42 <at> zip.com.au>
To: Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: 15006 <at> debbugs.gnu.org
Subject: Re: bug#15006: 24.3; emacs manual comment-start-skip example grouping
Date: Fri, 02 Aug 2013 11:50:00 +1000

Stefan Monnier <monnier <at> iro.umontreal.ca> writes:
>
>> If I understand the comment-start-skip docstring correctly a \(..\)
>> group is for extra distinguishing text preceding the comment.  Should
>> that example be a shy group,
>
> Indeed, thank you.

Actually I see the cc-mode code uses it with a group.  And js.el too
(perhaps copying cc-mode).  Does it have some subtle effect of skipping
the /*, or is it outright wrong?

> Yes, I prefer to stay away from "whitepace syntax" for that reason and
> would recommend [ \t]* in its stead.

I suppose the intention is to pick up non-breaking spaces or whatever
other flavours of whitespace.  Unlikely to arise in practice in
programming language stuff.  Is there an obvious ill effect?

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

From: Stefan Monnier <monnier <at> iro.umontreal.ca>
To: Kevin Ryde <user42 <at> zip.com.au>
Cc: 15006 <at> debbugs.gnu.org
Subject: Re: bug#15006: 24.3; emacs manual comment-start-skip example grouping
Date: Thu, 01 Aug 2013 22:30:59 -0400

> Actually I see the cc-mode code uses it with a group.  And js.el too
> (perhaps copying cc-mode).  Does it have some subtle effect of skipping
> the /*, or is it outright wrong?

It's wrong.  But cc-mode likes to reinvent the wheel, so maybe
it doesn't use much of that code anyway.

>> Yes, I prefer to stay away from "whitepace syntax" for that reason and
>> would recommend [ \t]* in its stead.
> I suppose the intention is to pick up non-breaking spaces or whatever
> other flavours of whitespace.  Unlikely to arise in practice in
> programming language stuff.  Is there an obvious ill effect?

You can get things like (re-search-forward comment-start-skip) and end
up with (match-end 0) past the end of the matched comment (e.g. when
matching "//\n").


        Stefan

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: 15006 <at> debbugs.gnu.org, Kevin Ryde <user42 <at> zip.com.au>
Subject: Re: bug#15006: 24.3; emacs manual comment-start-skip example grouping
Date: Sat, 21 Aug 2021 16:08:18 +0200

Stefan Monnier <monnier <at> iro.umontreal.ca> writes:

>> I suppose the intention is to pick up non-breaking spaces or whatever
>> other flavours of whitespace.  Unlikely to arise in practice in
>> programming language stuff.  Is there an obvious ill effect?
>
> You can get things like (re-search-forward comment-start-skip) and end
> up with (match-end 0) past the end of the matched comment (e.g. when
> matching "//\n").

I've now updated the example in the manual (as well as rearranged the
\\| to match the order of the description of the regexp) in Emacs 28.

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

Previous Next

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