From unknown Sun Jun 22 00:29:40 2025 X-Loop: help-debbugs@gnu.org Subject: bug#13572: 24.3.50; `describe-function' -> "This function has a compiler macro..." Resent-From: "Drew Adams" Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 28 Jan 2013 02:40:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 13572 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: To: 13572@debbugs.gnu.org X-Debbugs-Original-To: Received: via spool by submit@debbugs.gnu.org id=B.135934079030710 (code B ref -1); Mon, 28 Jan 2013 02:40:02 +0000 Received: (at submit) by debbugs.gnu.org; 28 Jan 2013 02:39:50 +0000 Received: from localhost ([127.0.0.1]:51877 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from ) id 1TzedR-0007zG-Se for submit@debbugs.gnu.org; Sun, 27 Jan 2013 21:39:50 -0500 Received: from eggs.gnu.org ([208.118.235.92]:54381) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from ) id 1TzedQ-0007zA-QQ for submit@debbugs.gnu.org; Sun, 27 Jan 2013 21:39:49 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Tzed2-00008U-Rw for submit@debbugs.gnu.org; Sun, 27 Jan 2013 21:39:25 -0500 X-Spam-Checker-Version: SpamAssassin 3.3.2 (2011-06-06) on eggs.gnu.org X-Spam-Level: X-Spam-Status: No, score=-104.6 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_MED, RP_MATCHES_RCVD, UNPARSEABLE_RELAY, USER_IN_WHITELIST autolearn=unavailable version=3.3.2 Received: from lists.gnu.org ([208.118.235.17]:43448) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Tzed2-00008P-Ou for submit@debbugs.gnu.org; Sun, 27 Jan 2013 21:39:24 -0500 Received: from eggs.gnu.org ([208.118.235.92]:37509) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Tzed1-0004Xh-S9 for bug-gnu-emacs@gnu.org; Sun, 27 Jan 2013 21:39:24 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Tzed0-00007z-VV for bug-gnu-emacs@gnu.org; Sun, 27 Jan 2013 21:39:23 -0500 Received: from userp1040.oracle.com ([156.151.31.81]:49103) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Tzed0-00007s-OL for bug-gnu-emacs@gnu.org; Sun, 27 Jan 2013 21:39:22 -0500 Received: from ucsinet22.oracle.com (ucsinet22.oracle.com [156.151.31.94]) by userp1040.oracle.com (Sentrion-MTA-4.2.2/Sentrion-MTA-4.2.2) with ESMTP id r0S2dKN2012963 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for ; Mon, 28 Jan 2013 02:39:21 GMT Received: from acsmt356.oracle.com (acsmt356.oracle.com [141.146.40.156]) by ucsinet22.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id r0S2dKDp005492 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO) for ; Mon, 28 Jan 2013 02:39:20 GMT Received: from abhmt110.oracle.com (abhmt110.oracle.com [141.146.116.62]) by acsmt356.oracle.com (8.12.11.20060308/8.12.11) with ESMTP id r0S2dK2Q023251 for ; Sun, 27 Jan 2013 20:39:20 -0600 Received: from dradamslap1 (/71.202.147.44) by default (Oracle Beehive Gateway v4.0) with ESMTP ; Sun, 27 Jan 2013 18:39:19 -0800 From: "Drew Adams" Date: Sun, 27 Jan 2013 18:39:10 -0800 Message-ID: <25708670B28E4172A0FC0979D00984FC@us.oracle.com> MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Mailer: Microsoft Office Outlook 11 Thread-Index: Ac39AKaRPAFJtGLMQ6Co8laO42ih6g== X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.6157 X-Source-IP: ucsinet22.oracle.com [156.151.31.94] X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.4.x-2.6.x [generic] X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6.x X-Received-From: 208.118.235.17 X-Spam-Score: -3.5 (---) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.13 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: debbugs-submit-bounces@debbugs.gnu.org Errors-To: debbugs-submit-bounces@debbugs.gnu.org X-Spam-Score: -4.3 (----) C-h f registerv-p The help says only this: This function has a compiler macro in `register.el'. This help is not very helpful. I, for one, do not understand it. Searching `register.el' does not turn up any definition of `registerv-p', that I can find. There are only invocations of the function in that file. And searching the Elisp manual for "compiler macro" turns up nothing. Perhaps this concept needs to be documented. Digging into help-fns.el I find that the test that produces this helpful message is (get function 'compiler-macro-file). But I haven't tried to search further to see what can be understood about this. Please document all of the constructs that you use in the Emacs source code, including this one. In GNU Emacs 24.3.50.1 (i386-mingw-nt5.1.2600) of 2013-01-25 on ODIEONE Bzr revision: 111604 eliz@gnu.org-20130125143821-1ykj7ia1qjojjjnp Windowing system distributor `Microsoft Corp.', version 5.1.2600 Configured using: `configure --with-gcc (4.7) --no-opt --enable-checking --cflags -IC:/Devel/emacs/build/include --ldflags -LC:/Devel/emacs/build/lib' From unknown Sun Jun 22 00:29:40 2025 X-Loop: help-debbugs@gnu.org Subject: bug#13572: 24.3.50; `describe-function' -> "This function has a compiler macro..." Resent-From: "Drew Adams" Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 28 Jan 2013 02:45:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 13572 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: To: <13572@debbugs.gnu.org> Received: via spool by 13572-submit@debbugs.gnu.org id=B13572.135934110231206 (code B ref 13572); Mon, 28 Jan 2013 02:45:02 +0000 Received: (at 13572) by debbugs.gnu.org; 28 Jan 2013 02:45:02 +0000 Received: from localhost ([127.0.0.1]:51887 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from ) id 1TzeiT-00087H-Ea for submit@debbugs.gnu.org; Sun, 27 Jan 2013 21:45:01 -0500 Received: from userp1040.oracle.com ([156.151.31.81]:32655) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from ) id 1TzeiR-000879-Oz for 13572@debbugs.gnu.org; Sun, 27 Jan 2013 21:45:00 -0500 Received: from acsinet21.oracle.com (acsinet21.oracle.com [141.146.126.237]) by userp1040.oracle.com (Sentrion-MTA-4.2.2/Sentrion-MTA-4.2.2) with ESMTP id r0S2iYQc016207 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for <13572@debbugs.gnu.org>; Mon, 28 Jan 2013 02:44:35 GMT Received: from acsmt356.oracle.com (acsmt356.oracle.com [141.146.40.156]) by acsinet21.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id r0S2iYQm017861 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO) for <13572@debbugs.gnu.org>; Mon, 28 Jan 2013 02:44:34 GMT Received: from abhmt115.oracle.com (abhmt115.oracle.com [141.146.116.67]) by acsmt356.oracle.com (8.12.11.20060308/8.12.11) with ESMTP id r0S2iYfX025363 for <13572@debbugs.gnu.org>; Sun, 27 Jan 2013 20:44:34 -0600 Received: from dradamslap1 (/71.202.147.44) by default (Oracle Beehive Gateway v4.0) with ESMTP ; Sun, 27 Jan 2013 18:44:33 -0800 From: "Drew Adams" References: <25708670B28E4172A0FC0979D00984FC@us.oracle.com> Date: Sun, 27 Jan 2013 18:44:24 -0800 Message-ID: <3F8F12B8F6B54805B9D0F822360663D6@us.oracle.com> MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Mailer: Microsoft Office Outlook 11 In-Reply-To: <25708670B28E4172A0FC0979D00984FC@us.oracle.com> Thread-Index: Ac39AKaRPAFJtGLMQ6Co8laO42ih6gAAEcwg X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.6157 X-Source-IP: acsinet21.oracle.com [141.146.126.237] X-Spam-Score: -1.9 (-) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.13 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: debbugs-submit-bounces@debbugs.gnu.org Errors-To: debbugs-submit-bounces@debbugs.gnu.org X-Spam-Score: -2.7 (--) Digging further (thanks to the doc string for `register-alist', and with prior knowledge of defstruct), I figured out that this is a type predicate constructed automatically for a register defstruct. The doc needs to be improved for this kind of thing (automatically generated functions). If you are going to add and use things like `defstruct', then please do it right. Emacs dev should not just be creating functions that have no doc willy nilly. From unknown Sun Jun 22 00:29:40 2025 X-Loop: help-debbugs@gnu.org Subject: bug#13572: 24.3.50; `describe-function' -> "This function has a compiler macro..." Resent-From: "Drew Adams" Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 28 Jan 2013 06:28:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 13572 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: To: <13572@debbugs.gnu.org> Received: via spool by 13572-submit@debbugs.gnu.org id=B13572.135935442418605 (code B ref 13572); Mon, 28 Jan 2013 06:28:02 +0000 Received: (at 13572) by debbugs.gnu.org; 28 Jan 2013 06:27:04 +0000 Received: from localhost ([127.0.0.1]:51950 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from ) id 1TziBC-0004pb-MA for submit@debbugs.gnu.org; Mon, 28 Jan 2013 01:27:01 -0500 Received: from aserp1040.oracle.com ([141.146.126.69]:47699) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from ) id 1TziB7-0004pR-Hn for 13572@debbugs.gnu.org; Mon, 28 Jan 2013 01:26:50 -0500 Received: from acsinet22.oracle.com (acsinet22.oracle.com [141.146.126.238]) by aserp1040.oracle.com (Sentrion-MTA-4.3.1/Sentrion-MTA-4.3.1) with ESMTP id r0S6QOSb030042 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for <13572@debbugs.gnu.org>; Mon, 28 Jan 2013 06:26:25 GMT Received: from acsmt358.oracle.com (acsmt358.oracle.com [141.146.40.158]) by acsinet22.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id r0S6QONA014838 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO) for <13572@debbugs.gnu.org>; Mon, 28 Jan 2013 06:26:24 GMT Received: from abhmt107.oracle.com (abhmt107.oracle.com [141.146.116.59]) by acsmt358.oracle.com (8.12.11.20060308/8.12.11) with ESMTP id r0S6QNwr018953 for <13572@debbugs.gnu.org>; Mon, 28 Jan 2013 00:26:23 -0600 Received: from dradamslap1 (/71.202.147.44) by default (Oracle Beehive Gateway v4.0) with ESMTP ; Sun, 27 Jan 2013 22:26:23 -0800 From: "Drew Adams" References: <25708670B28E4172A0FC0979D00984FC@us.oracle.com> <3F8F12B8F6B54805B9D0F822360663D6@us.oracle.com> Date: Sun, 27 Jan 2013 22:26:13 -0800 Message-ID: <6E0A1C25FDBF47CC8ABE955745D42FB6@us.oracle.com> MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Mailer: Microsoft Office Outlook 11 In-Reply-To: <3F8F12B8F6B54805B9D0F822360663D6@us.oracle.com> Thread-Index: Ac39AKaRPAFJtGLMQ6Co8laO42ih6gAAEcwgAAewCMA= X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.6157 X-Source-IP: acsinet22.oracle.com [141.146.126.238] X-Spam-Score: -1.9 (-) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.13 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: debbugs-submit-bounces@debbugs.gnu.org Errors-To: debbugs-submit-bounces@debbugs.gnu.org X-Spam-Score: -1.9 (-) > this is a type predicate constructed > automatically for a register defstruct. > > The doc needs to be improved for this kind of thing > (automatically generated functions). I guess Common Lisp defstruct does not allow for a doc string for the generated predicate (unlike the case for slots, constructor functions, and the defstruct itself). It would be good if Emacs Lisp could automatically generate a minimal doc string for the predicate that at least referred to the structure. Something like this: "Type predicate for a NAME structure." where NAME is the defstruct name. I guess that would be a wishlist item, since this is not part of the CL spec. Apart from that, in this particular defstruct it would be good to at least add doc strings for those things that allow it. A doc string for the defstruct itself is the least users could ask for. From unknown Sun Jun 22 00:29:40 2025 X-Loop: help-debbugs@gnu.org Subject: bug#13572: 24.3.50; `describe-function' -> "This function has a compiler macro..." Resent-From: Jambunathan K Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 28 Jan 2013 08:10:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 13572 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: To: "Drew Adams" Cc: 13572@debbugs.gnu.org Received: via spool by 13572-submit@debbugs.gnu.org id=B13572.135936057727735 (code B ref 13572); Mon, 28 Jan 2013 08:10:02 +0000 Received: (at 13572) by debbugs.gnu.org; 28 Jan 2013 08:09:37 +0000 Received: from localhost ([127.0.0.1]:51974 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from ) id 1Tzjmb-0007DI-79 for submit@debbugs.gnu.org; Mon, 28 Jan 2013 03:09:37 -0500 Received: from mail-pb0-f47.google.com ([209.85.160.47]:45288) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from ) id 1TzjmY-0007DA-Mj for 13572@debbugs.gnu.org; Mon, 28 Jan 2013 03:09:35 -0500 Received: by mail-pb0-f47.google.com with SMTP id rp8so558929pbb.34 for <13572@debbugs.gnu.org>; Mon, 28 Jan 2013 00:09:09 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=x-received:from:to:cc:subject:references:date:in-reply-to :message-id:user-agent:mime-version:content-type; bh=ZG3bLj6NpZGYWGdQh3WO2hjopXYSkFjtYSI6h+Y1I10=; b=wgCAEcElYolFvdmrakKsMGbm7proLzSyNgTn6GdoSMyH2szN30azuPNCjju2GMVVhw M7NpyjguAF7ErNIjbW8dqRsJCb08YtPB9ToUgP/qbardqNTLshWgSym9/TG3V8edM7Nf dpOyB3A+2cX4RhWf/23KnBOjVeuI60T4Ucr+2eh+PM+86xiWVS9P3TKLqibQtaPkQsz3 NybYifStK42NJ6dvG+dbrhFh3439jhTsp5KIR3Fvg4gc2ceHQlxzkRJbWpYDWFjEFfgT X90aBQy0g1VJmPHlS6gmh9nZjczVXF2RhM1pw4XTpu7p4Ojx8CKp1H5jpAcC9UAswTiU FiXg== X-Received: by 10.68.223.135 with SMTP id qu7mr35850037pbc.134.1359360549713; Mon, 28 Jan 2013 00:09:09 -0800 (PST) Received: from debian-6.05 ([115.242.131.195]) by mx.google.com with ESMTPS id p9sm6294667pao.29.2013.01.28.00.09.06 (version=TLSv1.1 cipher=RC4-SHA bits=128/128); Mon, 28 Jan 2013 00:09:08 -0800 (PST) From: Jambunathan K References: <25708670B28E4172A0FC0979D00984FC@us.oracle.com> <3F8F12B8F6B54805B9D0F822360663D6@us.oracle.com> <6E0A1C25FDBF47CC8ABE955745D42FB6@us.oracle.com> Date: Mon, 28 Jan 2013 13:38:55 +0530 In-Reply-To: <6E0A1C25FDBF47CC8ABE955745D42FB6@us.oracle.com> (Drew Adams's message of "Sun, 27 Jan 2013 22:26:13 -0800") Message-ID: <87sj5lpw4o.fsf@gmail.com> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/24.3.50 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain X-Spam-Score: 0.1 (/) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.13 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: debbugs-submit-bounces@debbugs.gnu.org Errors-To: debbugs-submit-bounces@debbugs.gnu.org X-Spam-Score: -1.2 (-) "Drew Adams" writes: >> this is a type predicate constructed >> automatically for a register defstruct. >> >> The doc needs to be improved for this kind of thing >> (automatically generated functions). > > I guess Common Lisp defstruct does not allow for a doc string for the generated > predicate (unlike the case for slots, constructor functions, and the defstruct > itself). > > It would be good if Emacs Lisp could automatically generate a minimal doc string > for the predicate that at least referred to the structure. Something like this: > > "Type predicate for a NAME structure." > > where NAME is the defstruct name. > > I guess that would be a wishlist item, since this is not part of the CL spec. > > Apart from that, in this particular defstruct it would be good to at least add > doc strings for those things that allow it. A doc string for the defstruct > itself is the least users could ask for. +1 I ran in to the some confusion while looking at compile.el - constructs like `compilation--message->loc' which are reported as compiler macros (Part of the confusion may be because of my ignorance. Only "macros" that I know of is `defmacros') ,---- | (cl-defstruct (compilation--message | (:constructor nil) | (:copier nil) | ;; (:type list) ;Old representation. | (:constructor compilation--make-message (loc type end-loc)) | (:conc-name compilation--message->)) | loc type end-loc) `---- Enhanced docstring can educate ignorant people like me... -- From debbugs-submit-bounces@debbugs.gnu.org Sat Feb 08 08:02:02 2014 Received: (at control) by debbugs.gnu.org; 8 Feb 2014 13:02:02 +0000 Received: from localhost ([127.0.0.1]:56682 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1WC7Xl-0002Gx-W2 for submit@debbugs.gnu.org; Sat, 08 Feb 2014 08:02:02 -0500 Received: from hermes.netfonds.no ([80.91.224.195]:57121) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1WC7Xj-0002Gj-I5 for control@debbugs.gnu.org; Sat, 08 Feb 2014 08:01:59 -0500 Received: from [204.14.154.233] (helo=building.gnus.org) by hermes.netfonds.no with esmtpsa (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.72) (envelope-from ) id 1WC7XU-0002oq-6y for control@debbugs.gnu.org; Sat, 08 Feb 2014 14:01:44 +0100 Date: Sat, 08 Feb 2014 05:00:33 -0800 Message-Id: <87eh3drc7i.fsf@building.gnus.org> To: control@debbugs.gnu.org From: Lars Ingebrigtsen Subject: control message for bug #13572 X-MailScanner-ID: 1WC7XU-0002oq-6y X-Netfonds-MailScanner: Found to be clean X-Netfonds-MailScanner-From: larsi@gnus.org MailScanner-NULL-Check: 1392469306.2382@alX5pcsJxinXTNuH3UHFSA X-Spam-Status: No X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: control X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: 0.0 (/) merge 13572 15031