GNU bug report logs - #30001
27.0.50; Outdated info on save-excursion in (info "(cl) Modify Macros")

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 30001 in the body.
You can then email your comments to 30001 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: Xu Chunyang <mail <at> xuchunyang.me>
To: bug-gnu-emacs <at> gnu.org
Subject: 27.0.50;
 Outdated info on save-excursion in (info "(cl) Modify Macros")
Date: Sat, 06 Jan 2018 13:29:57 +0800

'C-h S cl-letf' or (info "(cl) Modify Macros") has the following:

  Note that `cl-letf' on `(point)' is not quite like a
  `save-excursion', as the latter effectively saves a marker which
  tracks insertions and deletions in the buffer.

but 'save-excursion' is no longer saving marker since Emacs 25.1
according to 'C-h f save-excursion'.

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Xu Chunyang <mail <at> xuchunyang.me>
Cc: 30001 <at> debbugs.gnu.org
Subject: Re: bug#30001: 27.0.50;
 Outdated info on save-excursion in (info "(cl) Modify Macros")
Date: Sat, 06 Jan 2018 11:10:00 +0200

> From: Xu Chunyang <mail <at> xuchunyang.me>
> Date: Sat, 06 Jan 2018 13:29:57 +0800
> 
> 'C-h S cl-letf' or (info "(cl) Modify Macros") has the following:
> 
>   Note that `cl-letf' on `(point)' is not quite like a
>   `save-excursion', as the latter effectively saves a marker which
>   tracks insertions and deletions in the buffer.
> 
> but 'save-excursion' is no longer saving marker since Emacs 25.1
> according to 'C-h f save-excursion'.

save-excursion doesn't save the _mark_, but it still saves a _marker_
that tracks point, as opposed to just the value of point at the moment
of the call.

Do you have a practical use case where the documentation is incorrect?

Thanks.

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

From: Stephen Berman <stephen.berman <at> gmx.net>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: Xu Chunyang <mail <at> xuchunyang.me>, 30001 <at> debbugs.gnu.org
Subject: Re: bug#30001: 27.0.50;
 Outdated info on save-excursion in (info "(cl) Modify Macros")
Date: Sat, 06 Jan 2018 13:12:37 +0100

On Sat, 06 Jan 2018 11:10:00 +0200 Eli Zaretskii <eliz <at> gnu.org> wrote:

>> From: Xu Chunyang <mail <at> xuchunyang.me>
>> Date: Sat, 06 Jan 2018 13:29:57 +0800
>> 
>> 'C-h S cl-letf' or (info "(cl) Modify Macros") has the following:
>> 
>>   Note that `cl-letf' on `(point)' is not quite like a
>>   `save-excursion', as the latter effectively saves a marker which
>>   tracks insertions and deletions in the buffer.
>> 
>> but 'save-excursion' is no longer saving marker since Emacs 25.1
>> according to 'C-h f save-excursion'.
>
> save-excursion doesn't save the _mark_, but it still saves a _marker_
> that tracks point, as opposed to just the value of point at the moment
> of the call.

It looks like the doc string of save-excursion contains a few typos:

  Before Emacs 25.1, ‘save-excursion’ used to save the mark state.
  To save the marker state as well as the point and buffer, use
              ^^^^^^                  ^^^           ^^^^^^
  ‘save-mark-and-excursion’.

Shouldn't that be: "To save the mark state as well as point and the
buffer"?

Steve Berman

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Stephen Berman <stephen.berman <at> gmx.net>
Cc: mail <at> xuchunyang.me, 30001 <at> debbugs.gnu.org
Subject: Re: bug#30001: 27.0.50;
 Outdated info on save-excursion in (info "(cl) Modify Macros")
Date: Sat, 06 Jan 2018 17:15:36 +0200

> From: Stephen Berman <stephen.berman <at> gmx.net>
> Cc: Xu Chunyang <mail <at> xuchunyang.me>,  30001 <at> debbugs.gnu.org
> Date: Sat, 06 Jan 2018 13:12:37 +0100
> 
>   Before Emacs 25.1, ‘save-excursion’ used to save the mark state.
>   To save the marker state as well as the point and buffer, use
>               ^^^^^^                  ^^^           ^^^^^^
>   ‘save-mark-and-excursion’.
> 
> Shouldn't that be: "To save the mark state as well as point and the
> buffer"?

Of course.  Thanks, fixed.

Message #19 received at 30001-done <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Xu Chunyang <mail <at> xuchunyang.me>
Cc: 30001-done <at> debbugs.gnu.org
Subject: Re: bug#30001: 27.0.50;
 Outdated info on save-excursion in (info "(cl) Modify Macros")
Date: Sat, 06 Jan 2018 17:16:37 +0200

> From: Xu Chunyang <mail <at> xuchunyang.me>
> Date: Sat, 06 Jan 2018 20:31:12 +0800
> 
> > save-excursion doesn't save the _mark_, but it still saves a _marker_
> > that tracks point, as opposed to just the value of point at the moment
> > of the call.
> 
> I see. Please close the bug report since it is simply my
> misunderstanding. Thanks.

Done.

Previous Next

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