[bug#57122] [PATCH] build-system: emacs: Use new function for autoloads generation

[bug#57122] [PATCH] build-system: emacs: Use new function for autoloads generation

[Morgan.J.Smith]

From: Morgan Smith <Morgan.J.Smith@outlook.com>

* guix/build/emacs-utils.scm (emacs-generate-autoloads): Use
'loaddefs-generate' to create autoloads instead of
'update-directory-autoloads' if we are using a new enough Emacs
---

I'm not sure how long it takes to rebuild all the Emacs packages so I CC'd Liliana since they are going to change the Emacs build system soon anyways.

This change is to allow packages to be built with the latest commits of emacs (guix build emacs-crdt --with-input=emacs-minimal=emacs-next --with-latest=emacs-next)

Just last week the 'update-directory-autoloads' function got deprecated and replaced.  Since continuing to use the deprecated function would require changes anyways (adding a '(require 'autoloads)' would do it I think), I decided to just use the newer function.

Is this a bug in upstream Emacs where autoloaded functions like 'update-directory-autoloads' don't get autoloaded when they are in the obsolete directory?  Possibly.  Is this a bug related to our packaging of Emacs?  Possibly.  Is this the intended behaviour?  Possibly.  I'm not the guy to ask :P. I'm really not sure why this stopped working.  But we will have to switch to the 'loaddefs-generate' function eventually anyways so I think this patch is probably good to apply.


Thanks,

Morgan


 guix/build/emacs-utils.scm | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/guix/build/emacs-utils.scm b/guix/build/emacs-utils.scm
index 8ee547f2b3..180c3ae08c 100644
--- a/guix/build/emacs-utils.scm
+++ b/guix/build/emacs-utils.scm
@@ -105,7 +105,11 @@ (define (emacs-generate-autoloads name directory)
   (let* ((file (string-append directory "/" name "-autoloads.el"))
          (expr `(let ((backup-inhibited t)
                       (generated-autoload-file ,file))
-                  (update-directory-autoloads ,directory))))
+                  (if (not (require 'loaddefs-gen nil t))
+                      ;; Emacs <= 28
+                      (update-directory-autoloads ,directory)
+                    ;; Emacs >= 29
+                    (loaddefs-generate ,directory ,file)))))
     (emacs-batch-eval expr #:dynamic? #t)))
 
 (define* (emacs-byte-compile-directory dir)
-- 
2.37.1

[bug#57122] [PATCH] build-system: emacs: Use new function for autoloads generation

[Liliana Marie Prikler]

Am Mittwoch, dem 10.08.2022 um 13:37 -0400 schrieb
Morgan.J.Smith@outlook.com:
> From: Morgan Smith <Morgan.J.Smith@outlook.com>
> 
> * guix/build/emacs-utils.scm (emacs-generate-autoloads): Use
> 'loaddefs-generate' to create autoloads instead of
> 'update-directory-autoloads' if we are using a new enough Emacs
> ---
> 
> I'm not sure how long it takes to rebuild all the Emacs packages so I
> CC'd Liliana since they are going to change the Emacs build system
> soon anyways.
I can tack that onto native-comp no problem.  I can't recall the time
it took to rebuild everything for the last big upgrade, but it's
definitely something to do for fun and a little heat in winter.

> This change is to allow packages to be built with the latest commits
> of emacs (guix build emacs-crdt --with-input=emacs-minimal=emacs-next
> --with-latest=emacs-next)
> 
> Just last week the 'update-directory-autoloads' function got
> deprecated and replaced.  Since continuing to use the deprecated
> function would require changes anyways (adding a '(require
> 'autoloads)' would do it I think), I decided to just use the newer
> function.
> 
> Is this a bug in upstream Emacs where autoloaded functions like
> 'update-directory-autoloads' don't get autoloaded when they are in
> the obsolete directory?  Possibly.  Is this a bug related to our
> packaging of Emacs?  Possibly.  Is this the intended behaviour? 
> Possibly.  I'm not the guy to ask :P. I'm really not sure why this
> stopped working.  But we will have to switch to the 'loaddefs-
> generate' function eventually anyways so I think this patch is
> probably good to apply.
Can we instead use make-directory-autoloads or has that also been
deprecated in 29?  make-directory-autoloads exists since Emacs 28.1 and
seems to have the same signature as loaddefs-generate.  Any reason to
prefer the latter?


Cheers

[bug#57122] [PATCH] build-system: emacs: Use new function for autoloads generation

[Morgan Smith]

Liliana Marie Prikler <liliana.prikler@gmail.com> writes:

> Can we instead use make-directory-autoloads or has that also been
> deprecated in 29?  make-directory-autoloads exists since Emacs 28.1 and
> seems to have the same signature as loaddefs-generate.  Any reason to
> prefer the latter?

make-directory-autoloads is in autoloads.el which has been moved to a
directory named "obsolete" but the function itself hasn't been marked
obsolete.  I'm not really sure what that means but it looks like all the
autoloads stuff is being deprecated in favor of the newer loaddef stuff

[bug#57122] [PATCH] build-system: emacs: Use new function for autoloads generation

[Morgan Smith]

So the FreeBSD guys had the same issue but actually bothered to notify
upstream so the issue has been fixed:
https://debbugs.gnu.org/cgi/bugreport.cgi?bug=57200

That doesn't mean we shouldn't look into using a non-deprecated function
though.  Earlier I did try to use 'package-generate-autoloads' as that
seems like the ideal function to use but it adds the following string to
the loaddefs file:

"(add-to-list 'load-path (directory-file-name
                     (or (file-name-directory #$) (car load-path))))"

This line would probably work fine but for some reason when I tried it,
it didn't properly substitute '#$' with the file name.  I'm not really
sure how to fix that.

[bug#57122] [PATCH] build-system: emacs: Use new function for autoloads generation

[Liliana Marie Prikler]

Am Donnerstag, dem 18.08.2022 um 08:43 -0400 schrieb Morgan Smith:
> 
> So the FreeBSD guys had the same issue but actually bothered to
> notify upstream so the issue has been fixed:
> https://debbugs.gnu.org/cgi/bugreport.cgi?bug=57200
> 
> That doesn't mean we shouldn't look into using a non-deprecated
> function though.  Earlier I did try to use 'package-generate-
> autoloads' as that seems like the ideal function to use but it adds
> the following string to the loaddefs file:
> 
> "(add-to-list 'load-path (directory-file-name
>                      (or (file-name-directory #$) (car load-path))))"
> 
> This line would probably work fine but for some reason when I tried
> it, it didn't properly substitute '#$' with the file name.  I'm not
> really sure how to fix that.
Is "#$" a literal string?  You might want to substitute* the correct
directory in there after running package-generate-autoloads.

As for make-directory-autoloads vs. loaddefs-generate, IIRC both have
the same signature, so you could make this work with both the non-
deprecated function in Emacs 28 and the new one added in Emacs 29.

Cheers