GNU bug report logs - #57263
29.0.50; Obsolete documentation of `cl-symbol-macrolet'

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 57263 in the body.
You can then email your comments to 57263 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: Wing Hei Chan <whmunkchan <at> outlook.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 29.0.50; Obsolete documentation of `cl-symbol-macrolet'
Date: Wed, 17 Aug 2022 18:26:44 +0800

The documentation of `cl-symbol-macrolet' fails to reflect the changes
in "Fix bug#26073", that is, `let'-bindings shadow symbol macro
bindings.

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Wing Hei Chan <whmunkchan <at> outlook.com>,
 Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: 57263 <at> debbugs.gnu.org
Subject: Re: bug#57263: 29.0.50; Obsolete documentation of `cl-symbol-macrolet'
Date: Thu, 18 Aug 2022 10:56:32 +0300

> Date: Wed, 17 Aug 2022 18:26:44 +0800
> From: Wing Hei Chan <whmunkchan <at> outlook.com>
> 
> The documentation of `cl-symbol-macrolet' fails to reflect the changes
> in "Fix bug#26073", that is, `let'-bindings shadow symbol macro
> bindings.

Stefan, could you please fix the documentation, or suggest how it
should be fixed?

Thanks.

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

From: Stefan Monnier <monnier <at> iro.umontreal.ca>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 57263 <at> debbugs.gnu.org, Wing Hei Chan <whmunkchan <at> outlook.com>
Subject: Re: bug#57263: 29.0.50; Obsolete documentation of `cl-symbol-macrolet'
Date: Thu, 18 Aug 2022 10:08:10 -0400

> Stefan, could you please fix the documentation, or suggest how it
> should be fixed?

Does the patch below seem readable to you?


        Stefan


diff --git a/doc/misc/cl.texi b/doc/misc/cl.texi
index 07c19e37ce4..a7548bb1f8a 100644
--- a/doc/misc/cl.texi
+++ b/doc/misc/cl.texi
@@ -1381,19 +1381,10 @@ Macro Bindings
 
 A @code{setq} of a symbol macro is treated the same as a @code{setf}.
 I.e., @code{(setq foo 4)} in the above would be equivalent to
-@code{(setf foo 4)}, which in turn expands to @code{(setf (car bar) 4)}.
-
-Likewise, a @code{let} or @code{let*} binding a symbol macro is
-treated like a @code{cl-letf} or @code{cl-letf*}.  This differs from true
-Common Lisp, where the rules of lexical scoping cause a @code{let}
-binding to shadow a @code{symbol-macrolet} binding.  In this package,
-such shadowing does not occur, even when @code{lexical-binding} is
-@c See https://debbugs.gnu.org/12119
-@code{t}.  (This behavior predates the addition of lexical binding to
-Emacs Lisp, and may change in future to respect @code{lexical-binding}.)
-At present in this package, only @code{lexical-let} and
-@code{lexical-let*} will shadow a symbol macro.  @xref{Obsolete
-Lexical Binding}.
+@code{(setf foo 4)}, which in turn expands to @code{(setf (car bar)
+4)}.  A @code{let} (or @code{let*}, @code{lambda}, ...) binding of
+the same symbol will locally shadow the symbol macro as is the case in
+Common Lisp.
 
 There is no analogue of @code{defmacro} for symbol macros; all symbol
 macros are local.  A typical use of @code{cl-symbol-macrolet} is in the

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: 57263 <at> debbugs.gnu.org, whmunkchan <at> outlook.com
Subject: Re: bug#57263: 29.0.50; Obsolete documentation of `cl-symbol-macrolet'
Date: Thu, 18 Aug 2022 19:04:42 +0300

> From: Stefan Monnier <monnier <at> iro.umontreal.ca>
> Cc: Wing Hei Chan <whmunkchan <at> outlook.com>,  57263 <at> debbugs.gnu.org
> Date: Thu, 18 Aug 2022 10:08:10 -0400
> 
> > Stefan, could you please fix the documentation, or suggest how it
> > should be fixed?
> 
> Does the patch below seem readable to you?

LGTM, thanks.

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

From: Stefan Monnier <monnier <at> iro.umontreal.ca>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 57263-done <at> debbugs.gnu.org, whmunkchan <at> outlook.com
Subject: Re: bug#57263: 29.0.50; Obsolete documentation of `cl-symbol-macrolet'
Date: Thu, 18 Aug 2022 12:29:22 -0400

>> Does the patch below seem readable to you?
> LGTM, thanks.

Installed,


        Stefan

Previous Next

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