From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#29048: 26.0.90; [PATCH] Improve documentation on Edebug and macros Date: Fri, 03 Nov 2017 15:41:32 +0200 Message-ID: <83mv43v5rn.fsf@gnu.org> References: <87mv4abwco.fsf@runbox.com> Reply-To: Eli Zaretskii NNTP-Posting-Host: blaine.gmane.org X-Trace: blaine.gmane.org 1509716540 9335 195.159.176.226 (3 Nov 2017 13:42:20 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Fri, 3 Nov 2017 13:42:20 +0000 (UTC) Cc: 29048@debbugs.gnu.org To: Gemini Lasswell Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Fri Nov 03 14:42:12 2017 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1eAcEe-0001p5-6Q for geb-bug-gnu-emacs@m.gmane.org; Fri, 03 Nov 2017 14:42:12 +0100 Original-Received: from localhost ([::1]:36795 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eAcEl-00025R-B9 for geb-bug-gnu-emacs@m.gmane.org; Fri, 03 Nov 2017 09:42:19 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:36876) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eAcEZ-00022R-V0 for bug-gnu-emacs@gnu.org; Fri, 03 Nov 2017 09:42:11 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1eAcEU-0003hx-4s for bug-gnu-emacs@gnu.org; Fri, 03 Nov 2017 09:42:07 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:40215) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1eAcEU-0003hZ-1S for bug-gnu-emacs@gnu.org; Fri, 03 Nov 2017 09:42:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1eAcET-0001MK-Qf for bug-gnu-emacs@gnu.org; Fri, 03 Nov 2017 09:42:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 03 Nov 2017 13:42:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 29048 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 29048-submit@debbugs.gnu.org id=B29048.15097165085199 (code B ref 29048); Fri, 03 Nov 2017 13:42:01 +0000 Original-Received: (at 29048) by debbugs.gnu.org; 3 Nov 2017 13:41:48 +0000 Original-Received: from localhost ([127.0.0.1]:48895 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1eAcEG-0001Ll-A1 for submit@debbugs.gnu.org; Fri, 03 Nov 2017 09:41:48 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:45734) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1eAcED-0001LX-JR for 29048@debbugs.gnu.org; Fri, 03 Nov 2017 09:41:45 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1eAcE3-0002xu-Ca for 29048@debbugs.gnu.org; Fri, 03 Nov 2017 09:41:40 -0400 Original-Received: from fencepost.gnu.org ([2001:4830:134:3::e]:55842) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eAcE3-0002xb-8J; Fri, 03 Nov 2017 09:41:35 -0400 Original-Received: from [176.228.60.248] (port=2062 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1eAcE2-0004Wa-KO; Fri, 03 Nov 2017 09:41:35 -0400 In-reply-to: <87mv4abwco.fsf@runbox.com> (message from Gemini Lasswell on Sat, 28 Oct 2017 18:01:43 -0700) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 208.118.235.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" Xref: news.gmane.org gmane.emacs.bugs:139412 Archived-At: > From: Gemini Lasswell > Date: Sat, 28 Oct 2017 18:01:43 -0700 > > Here are a few suggestions to try to make that dense section of the > manual on Edebug and macros a little clearer. Thanks, this is okay for the release branch. > I'd like to remove mention of eval-when-compile from the explanation > of how to make sure macro specifications are available, because it's > not the only way to get yourself in that situation. If you navigate to > a function in a file that's not yet loaded which uses a macro in a > different file required by the first file and also not yet loaded, and > C-u C-M-x, Edebug will complain due to the lack of macro spec > regardless of whether the never-executed require in the first file was > wrapped with eval-when-compile. That's okay, but please mention eval-when-compile as an example of the broader class of situations with instrumenting code wrapped with macros. > * doc/lispref/edebug.texi (Instrumenting Macro Calls): Refer to > `require' instead of `eval-when-compile' in discussion of loading > macro specifications before instrumenting. In log entries and in NEWS, we use quoting 'like this' nowadays, not `like this'.