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 09:13:03 +0300 Message-ID: <83mtd3ngcw.fsf@gnu.org> References: <83bktlnuog.fsf@gnu.org> <83sfmxm79z.fsf@gnu.org> <83fsiwncem.fsf@gnu.org> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="20567"; 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 08:15:11 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 1oEPSo-0005BT-Hc for ged-emacs-devel@m.gmane-mx.org; Thu, 21 Jul 2022 08:15:10 +0200 Original-Received: from localhost ([::1]:42346 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1oEPSn-0000k4-8p for ged-emacs-devel@m.gmane-mx.org; Thu, 21 Jul 2022 02:15:09 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:49066) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oEPQu-0008R7-I5 for emacs-devel@gnu.org; Thu, 21 Jul 2022 02:13:12 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:46610) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oEPQt-0002ft-NV; Thu, 21 Jul 2022 02:13:11 -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=dESW0GSYhpa01ZpQq55rOUHlif62myACU7oyyNutp0w=; b=N3k1/EVvBMND DzxnTtfKjwoQa1KA90Qh2pq27omrslJx7pwyuOlwxw7FK7SxFSwmNaFKUJTijPf3nIPn66soWkIoC WT03DOTNNLYKjQPzrFvSAu4b6ExZrDX5BIah/7m1ittXePXfd9no3dRZ3+bSGjcbmzvCXX0c2/p0M e9ZQ+ZkGhzZ0qlpcWcEVUbOXEOA4pzPsbhay1lwmr2g9AkJYWXMQ3QxG8HRvZPFQavHKKzEZrF1Fm drNpS9Zw5ivluhweldFUPp8UA6mlqXtv0GCeW+iDObYhuUnLPtdHvRNgo5Kas9HonjdkjI+y3gAkq qF1FMinOGii3eqTrk5ixrw==; Original-Received: from [87.69.77.57] (port=2980 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 1oEPQs-0006tu-Tw; Thu, 21 Jul 2022 02:13:11 -0400 In-Reply-To: (message from Alan Mackenzie on Wed, 20 Jul 2022 20:34:05 +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:292328 Archived-At: > Date: Wed, 20 Jul 2022 20:34:05 +0000 > Cc: emacs-devel@gnu.org > From: Alan Mackenzie > > Here's a first preliminary effort at amending loading.texi: Thanks, but in "needs work"(TM). > @defun symbol-file symbol &optional type > -This function returns the name of the file that defined @var{symbol}. > -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 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. > @defvar load-history > -The value of this variable is an alist that associates the names of > -loaded library files with the names of the functions and variables > -they defined, as well as the features they provided or required. > +The value of this variable is an alist that associates names > +associated with loaded library files (@pxref{eln files}) with the > +names of the functions and variables the files defined, as well as the > +features they provided or required. Likewise. > Each element in this alist describes one loaded library (including > libraries that are preloaded at startup). It is a list whose @sc{car} > -is the absolute file name of the library (a string). The rest of the > -list elements have these forms: > +is an absolute file name associated with the library (a string) > +(@pxref{eln files}). The rest of the list elements have these forms: Likewise. > - The command @code{eval-region} updates @code{load-history}, but does so > -by adding the symbols defined to the element for the file being visited, > -rather than replacing that element. @xref{Eval}. > +@anchor{eln files} For backwards compatibility, @code{load-history} > +stores and @code{symbol-file} returns the name of a notional byte > +compiled @file{.elc} file in the same directory as its source file > +when the real file loaded from is a natively compiled file elsewhere. > +This @file{.elc} file may or may not actually exist. For other files, > +their absolute file names are used. This last sentence is "out of the blue": what "other files"? The text should also have a cross-reference to where native compilation is described in the manual. > 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. Also, native-comp-unit-file doesn't exist in a build without native compilation support, so some feature test is missing. Finally, "FOO" is not how we refer to a meta-syntactic variable in the manual: we use @var{foo} instead. > +The command @code{eval-region} updates @code{load-history}, but does > +so by adding the symbols defined to the element for the file being > +visited, rather than replacing that element. @xref{Eval}. This part should be before the text which explains the issues with loading *.eln files.