bug#690: 23.0.60; Function origin file misremembered

bug#690: 23.0.60; Function origin file misremembered

[Markus Triska]

Let ~/prolog.el consist of the forms:

   (defun prolog-mode ()
     (interactive)
     (message "hi"))

   (provide 'prolog)

When I do "$ emacs -Q" and evaluate:

   (progn
     (add-to-list 'load-path "~/")
     (autoload 'prolog-mode "prolog" "Prolog mode" t)
     (prolog-mode))

the message "hi" is displayed, like every further time I evaluate
(prolog-mode). "C-h f prolog-mode RET" shows:

   prolog-mode is a Lisp function in `prolog.el'.

When I follow the link (`prolog.el'), it leads me to the wrong file,
namely ~/emacs/lisp/progmodes/prolog.el, i.e., part of Emacs source.


In GNU Emacs 23.0.60.1 (i386-apple-darwin8.11.1, GTK+ Version 2.12.9)
 of 2008-08-08 on pnsgw1-client079.demo.tuwien.ac.at
Windowing system distributor `The XFree86 Project, Inc', version 11.0.40400000
Important settings:
  value of $LC_ALL: nil
  value of $LC_COLLATE: nil
  value of $LC_CTYPE: nil
  value of $LC_MESSAGES: nil
  value of $LC_MONETARY: nil
  value of $LC_NUMERIC: nil
  value of $LC_TIME: nil
  value of $LANG: en.UTF-8
  value of $XMODIFIERS: nil
  locale-coding-system: nil
  default-enable-multibyte-characters: t

bug#690: 23.0.60; Function origin file misremembered

[ＯＦＦＩＣＥ ZERO]

Do not send me any mail !
No thank you　！！




----- Original Message ----- 
From: "Markus Triska" <markus.triska@gmx.at>
To: <emacs-pretest-bug@gnu.org>
Sent: Monday, August 11, 2008 9:43 AM
Subject: bug#690: 23.0.60; Function origin file misremembered


>
> Let ~/prolog.el consist of the forms:
>
>   (defun prolog-mode ()
>     (interactive)
>     (message "hi"))
>
>   (provide 'prolog)
>
> When I do "$ emacs -Q" and evaluate:
>
>   (progn
>     (add-to-list 'load-path "~/")
>     (autoload 'prolog-mode "prolog" "Prolog mode" t)
>     (prolog-mode))
>
> the message "hi" is displayed, like every further time I evaluate
> (prolog-mode). "C-h f prolog-mode RET" shows:
>
>   prolog-mode is a Lisp function in `prolog.el'.
>
> When I follow the link (`prolog.el'), it leads me to the wrong file,
> namely ~/emacs/lisp/progmodes/prolog.el, i.e., part of Emacs source.
>
>
> In GNU Emacs 23.0.60.1 (i386-apple-darwin8.11.1, GTK+ Version 2.12.9)
> of 2008-08-08 on pnsgw1-client079.demo.tuwien.ac.at
> Windowing system distributor `The XFree86 Project, Inc', version 
> 11.0.40400000
> Important settings:
>  value of $LC_ALL: nil
>  value of $LC_COLLATE: nil
>  value of $LC_CTYPE: nil
>  value of $LC_MESSAGES: nil
>  value of $LC_MONETARY: nil
>  value of $LC_NUMERIC: nil
>  value of $LC_TIME: nil
>  value of $LANG: en.UTF-8
>  value of $XMODIFIERS: nil
>  locale-coding-system: nil
>  default-enable-multibyte-characters: t
>
>
>
>
> 

bug#690: 23.0.60; Function origin file misremembered

[martin rudalics]

 > "C-h f prolog-mode RET" shows:
 >
 >    prolog-mode is a Lisp function in `prolog.el'.
 >
 > When I follow the link (`prolog.el'), it leads me to the wrong file,
 > namely ~/emacs/lisp/progmodes/prolog.el, i.e., part of Emacs source.

Could you please try to instrument the function `find-source-lisp-file'
(in help-fns.el) for debugging before you do C-h f and tell me what it
finds?

martin

bug#690: 23.0.60; Function origin file misremembered

[Markus Triska]

martin rudalics <rudalics@gmx.at> writes:

> Could you please try to instrument the function `find-source-lisp-file'
> (in help-fns.el) for debugging before you do C-h f and tell me what it
> finds?

`describe-simplify-lib-file-name' already converts "/Users/mt/prolog.el"
to "prolog.el", which I think it should not do to preserve the origin.
`find-source-lisp-file' then expands it to the Emacs source file.

bug#690: 23.0.60; Function origin file misremembered

[martin rudalics]

 >> Could you please try to instrument the function `find-source-lisp-file'
 >> (in help-fns.el) for debugging before you do C-h f and tell me what it
 >> finds?
 >
 > `describe-simplify-lib-file-name' already converts "/Users/mt/prolog.el"
 > to "prolog.el", which I think it should not do to preserve the origin.
 > `find-source-lisp-file' then expands it to the Emacs source file.

Maybe.  Any ideas how to do that without breaking the rest of the code?

IIUC the problem is with `find-source-lisp-file' which searches for an
`elc-file' that does not exist for _your_ prolog.el, finds the compiled,
built-in one instead, ...

martin

bug#690: 23.0.60; Function origin file misremembered

[Lennart Borgman (gmail)]

martin rudalics wrote:
>  >> Could you please try to instrument the function `find-source-lisp-file'
>  >> (in help-fns.el) for debugging before you do C-h f and tell me what it
>  >> finds?
>  >
>  > `describe-simplify-lib-file-name' already converts "/Users/mt/prolog.el"
>  > to "prolog.el", which I think it should not do to preserve the origin.
>  > `find-source-lisp-file' then expands it to the Emacs source file.
> 
> Maybe.  Any ideas how to do that without breaking the rest of the code?
> 
> IIUC the problem is with `find-source-lisp-file' which searches for an
> `elc-file' that does not exist for _your_ prolog.el, finds the compiled,
> built-in one instead, ...

How about checking file mod time?

bug#690: 23.0.60; Function origin file misremembered

[Markus Triska]

martin rudalics <rudalics@gmx.at> writes:

>> `describe-simplify-lib-file-name' already converts "/Users/mt/prolog.el"
>> to "prolog.el", which I think it should not do to preserve the origin.
>> `find-source-lisp-file' then expands it to the Emacs source file.

>  Any ideas how to do that without breaking the rest of the code?

I do not see much value in abbreviating the file name at all; unless
that is important for other features to work, I find that the original
file name should be preserved in case of doubt. (symbol-file
'prolog-mode) correctly evaluates to "/Users/mt/prolog.el", so this is
what should be shown. Otherwise, even future changes to load-path could
lead to distorted file origins of functions that are already loaded.

bug#690: 23.0.60; Function origin file misremembered

[martin rudalics]

The mod time of Markus' prolog.el might more "accurately" reflect that
of the built-in prolog.elc than that of the built-in prolog.el for
whatever definition of "accurately" you provide :-(

martin

bug#690: 23.0.60; Function origin file misremembered

[martin rudalics]

 > I do not see much value in abbreviating the file name at all; unless
 > that is important for other features to work, I find that the original
 > file name should be preserved in case of doubt. (symbol-file
 > 'prolog-mode) correctly evaluates to "/Users/mt/prolog.el", so this is
 > what should be shown. Otherwise, even future changes to load-path could
 > lead to distorted file origins of functions that are already loaded.

`load-path' is fragile.  Consider the case where you have duplicates of
files foo.el and bar.el in two different directories that are both in
`load-path'.  You can't insist on finding foo.el in one and bar.el in
the other directory.  As I proposed in another thread we could try to
_always_ find the definition from `symbol-file' and use that from the
build directory iff the former fails.  This should handle your case as
well.

martin

bug#690: 23.0.60; Function origin file misremembered

[martin rudalics]

[-- Attachment #1: Type: text/plain, Size: 539 bytes --]

 > I do not see much value in abbreviating the file name at all; unless
 > that is important for other features to work, I find that the original
 > file name should be preserved in case of doubt. (symbol-file
 > 'prolog-mode) correctly evaluates to "/Users/mt/prolog.el", so this is
 > what should be shown. Otherwise, even future changes to load-path could
 > lead to distorted file origins of functions that are already loaded.

Do people see problems if we do not simplify the filename when the
libname is not a compiled file?

martin

[-- Attachment #2: 690.diff --]
[-- Type: text/plain, Size: 908 bytes --]

*** help-fns.el.~1.123.~	2008-07-28 15:19:09.000000000 +0200
--- help-fns.el	2008-08-11 17:49:09.375000000 +0200
***************
*** 225,234 ****
        (let ((libname (file-name-nondirectory file)))
  	;; Now convert that back to a file name and see if we get
  	;; the original one.  If so, they are equivalent.
! 	(if (equal file (locate-file libname load-path '("")))
! 	    (if (string-match "[.]elc\\'" libname)
! 		(substring libname 0 -1)
! 	      libname)
  	  file))))
  
  (defun find-source-lisp-file (file-name)
--- 225,233 ----
        (let ((libname (file-name-nondirectory file)))
  	;; Now convert that back to a file name and see if we get
  	;; the original one.  If so, they are equivalent.
! 	(if (and (equal file (locate-file libname load-path '("")))
! 		 (string-match "[.]elc\\'" libname))
! 	    (substring libname 0 -1)
  	  file))))
  
  (defun find-source-lisp-file (file-name)