From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.devel Subject: Re: How does one find out what file a library has been loaded from? Date: Thu, 21 Jul 2022 20:53:28 +0300 Message-ID: <838rommjxj.fsf@gnu.org> References: <83bktlnuog.fsf@gnu.org> <83sfmxm79z.fsf@gnu.org> <83fsiwncem.fsf@gnu.org> <83mtd3ngcw.fsf@gnu.org> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="26076"; mail-complaints-to="usenet@ciao.gmane.io" Cc: emacs-devel@gnu.org To: Alan Mackenzie Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Thu Jul 21 19:55:20 2022 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1oEaON-0006ZP-PG for ged-emacs-devel@m.gmane-mx.org; Thu, 21 Jul 2022 19:55:19 +0200 Original-Received: from localhost ([::1]:54384 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1oEaOM-0000yL-BA for ged-emacs-devel@m.gmane-mx.org; Thu, 21 Jul 2022 13:55:18 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:38872) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oEaMi-00081e-BF for emacs-devel@gnu.org; Thu, 21 Jul 2022 13:53:37 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:56074) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oEaMh-0003vL-VB; Thu, 21 Jul 2022 13:53:35 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=7X2/a8q8Uuiagx7R+h1vk0txeOH0XiuEFVw95zbUZX0=; b=F/+awNCbrz6f 3BG2PSKUHAY1WKufcEJrGADeTT5KB19e+V3WUM+gjIUNvLThQKvFU6+gfq986xKuL3qvF0vq1Bv42 ++jtT8Sbp9vs68XIJa/iduTtz3gTObi5Evo6TqVaP294ykKf2xtXgsfruIipJ2sSXe2hq6i/klrol hmk5uc373VpM3OWX8r8P4sBUvRzOsLO2VljDQinX14yuxNz1pCcU+igOUx0hPr5IFNn3r4TS4xyPz URXlGpwlmHKp+uUuklbLfF1uFY6CUDQufzcewO2GxJ68T4WoQfXIe180ZH4Mxiz73qF3jEzvAXOyP c1cVKOuuJoq6bQqGS0uTqQ==; Original-Received: from [87.69.77.57] (port=2763 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oEaMh-0001Jj-DN; Thu, 21 Jul 2022 13:53:35 -0400 In-Reply-To: (message from Alan Mackenzie on Thu, 21 Jul 2022 17:37:19 +0000) X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.io gmane.emacs.devel:292389 Archived-At: > Date: Thu, 21 Jul 2022 17:37:19 +0000 > Cc: emacs-devel@gnu.org > From: Alan Mackenzie > > > > +This function returns a file name associated with the file that > > > +defined @var{symbol} (@pxref{eln files}). If @var{type} is > > > +@code{nil}, then any kind of definition is acceptable. If @var{type} > > > +is @code{defun}, @code{defvar}, or @code{defface}, that specifies > > > +function definition, variable definition, or face definition only. > > > This change is for the worse: it introduces a vague and confusing > > notion of "file name associated with the file that defines" a symbol. > > This should be removed from the patch, as it doesn't add any useful > > information, just muddies the waters. > > It's accurate, though. No, it isn't accurate, because it doesn't say anything definitive. What exactly did you want to say here, and why? (See, I didn't even understand you intention, from reading that text.) > > > If you want to find the actual > > > +file loaded from, and you suspect if may really be a native compiled > > > +file, something like the following should help. You need to know the > > > +name of a function which hasn't been advised, say @var{foo}, defined > > > +in the suspected native compiled file. Then > > > + > > > +@lisp > > > +(let ((foo-fun (symbol-function #'FOO))) > > > + (and foo-fun (subr-native-elisp-p foo-fun) > > > + (native-comp-unit-file (subr-native-comp-unit foo-fun)))) > > > +@end lisp > > > + > > > +@noindent > > > +will return either the name of the native compiled file defining > > > +@var{foo}, or @code{nil} if there is no such file. > > > This is not a good way of documenting some technique in this manual. > > The way we describe such stuff is by documenting the functions a > > program needs to use, not by giving a random example which calls the > > functions without any documentation of the functions themselves. > > OK. But I think here could be an exception. Describing the functions > separately on their own page will not help users to get the loaded file > name without a great deal of research. You can describe them, and then show the example. Or fill in the blanks as part of the functions' description. > I've tried out this recipe and > it works, but I don't yet know what these native-comp-unit functions are > for, what they do in any detail, or even what a compilation-unit is. > The functions are not already in the Elisp manual, and their doc strings > are somewhat terse. If you cannot figure it out from the code, feel free to ask questions. > I still think it would be a good thing to be able to get the name of an > actual load file from the .elc name stored in load-history without > having to go through the intermediate step of knowing a function name > defined by it. Did you try comp-el-to-eln-filename? > > Also, native-comp-unit-file doesn't exist in a build without native > > compilation support, so some feature test is missing. > > Do you mean a test in the TexInfo sources which would test whether it's > necessary to include that example in the finished manual? No, I mean a test in the @example code. You want that snippet to be complete, so that readers could copy it into their programs, right?