bug#57144: 29.0.50; Missing description for excluded files in docstring of loaddefs-generate

bug#57144: 29.0.50; Missing description for excluded files in docstring of loaddefs-generate

[Arash Esbati]

Hi all,

This is the docstring of `loaddefs-generate':

,----[ C-h f loaddefs-generate RET ]
| loaddefs-generate is an autoloaded Lisp function in ‘loaddefs-gen.el’.
| 
| (loaddefs-generate DIR OUTPUT-FILE &optional EXCLUDED-FILES EXTRA-DATA
| INCLUDE-PACKAGE-VERSION GENERATE-FULL)
| 
| Generate loaddefs files for Lisp files in the directories DIRS.
| DIR can be either a single directory or a list of directories.
| 
| The autoloads will be written to OUTPUT-FILE.  If any Lisp file
| binds ‘generated-autoload-file’ as a file-local variable, write
| its autoloads into the specified file instead.
| 
| The function does NOT recursively descend into subdirectories of the
| directory or directories specified.
| 
| If EXTRA-DATA, include this string at the start of the generated
| file.  This will also force generation of OUTPUT-FILE even if
| there are no autoloads to put into the file.
| 
| If INCLUDE-PACKAGE-VERSION, include package version data.
| 
| If GENERATE-FULL, don’t update, but regenerate all the loaddefs files.
`----

A description for EXCLUDED-FILES is missing.  It will a list containing
file names, but details should be added.

Best, Arash

bug#57144: 29.0.50; Missing description for excluded files in docstring of loaddefs-generate

[Eli Zaretskii]

> From: Arash Esbati <arash@gnu.org>
> Date: Thu, 11 Aug 2022 21:31:32 +0200
> 
> A description for EXCLUDED-FILES is missing.  It will a list containing
> file names, but details should be added.

Thanks, fixed.

bug#57144: 29.0.50; Missing description for excluded files in docstring of loaddefs-generate

[Arash Esbati]

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

Eli Zaretskii <eliz@gnu.org> writes:

>> From: Arash Esbati <arash@gnu.org>
>> Date: Thu, 11 Aug 2022 21:31:32 +0200
>> 
>> A description for EXCLUDED-FILES is missing.  It will a list containing
>> file names, but details should be added.
>
> Thanks, fixed.

Thanks for the quick fix.  I still can't get files excluded in the
generation process.  Please consider the 3 simple .el files attached and
save them under ~/Test/.  Now eval in *scratch*

(loaddefs-generate "~/Test/"
                   "~/Test/autoload.el"
                   '("ignore.el") nil nil t)

or

(loaddefs-generate "~/Test/"
                   "~/Test/autoload.el"
                   '("~/Test/input-ignore.el") nil nil t)

autoloads from input-ignore.el aren't ignored.  Am I missing something?

Best, Arash


[-- Attachment #2: input-one.el --]
[-- Type: application/emacs-lisp, Size: 436 bytes --]

;;; input-one.el ---   -*- lexical-binding: t; -*-

;;; Code:

;;;###autoload
(defun input-one-mode-1 ()
  "docstring"
  (message "autoload me"))

;;;###autoload
(defun input-one-mode-2 ()
  "docstring"
  (message "autoload me"))

;;;###autoload
(defun input-one-mode-3 ()
  "docstring"
  (message "autoload me"))

(provide 'input-one)

;; Local Variables:
;; coding: utf-8
;; End:

;;; input-one.el ends here

[-- Attachment #3: input-two.el --]
[-- Type: application/emacs-lisp, Size: 436 bytes --]

;;; input-two.el ---   -*- lexical-binding: t; -*-

;;; Code:

;;;###autoload
(defun input-two-mode-1 ()
  "docstring"
  (message "autoload me"))

;;;###autoload
(defun input-two-mode-2 ()
  "docstring"
  (message "autoload me"))

;;;###autoload
(defun input-two-mode-3 ()
  "docstring"
  (message "autoload me"))

(provide 'input-two)

;; Local Variables:
;; coding: utf-8
;; End:

;;; input-two.el ends here

[-- Attachment #4: input-ignore.el --]
[-- Type: application/emacs-lisp, Size: 454 bytes --]

;;; input-ignore.el ---   -*- lexical-binding: t; -*-

;;; Code:

;;;###autoload
(defun input-ignore-mode-1 ()
  "docstring"
  (message "autoload me"))

;;;###autoload
(defun input-ignore-mode-2 ()
  "docstring"
  (message "autoload me"))

;;;###autoload
(defun input-ignore-mode-3 ()
  "docstring"
  (message "autoload me"))

(provide 'input-ignore)

;; Local Variables:
;; coding: utf-8
;; End:

;;; input-ignore.el ends here

bug#57144: 29.0.50; Missing description for excluded files in docstring of loaddefs-generate

[Lars Ingebrigtsen]

Arash Esbati <arash@gnu.org> writes:

> (loaddefs-generate "~/Test/"
>                    "~/Test/autoload.el"
>                    '("~/Test/input-ignore.el") nil nil t)
>
> autoloads from input-ignore.el aren't ignored.  Am I missing something?

The excluded files weren't expanded.  I've now fixed this in Emacs 29.

bug#57144: 29.0.50; Missing description for excluded files in docstring of loaddefs-generate

[Arash Esbati]

Lars Ingebrigtsen <larsi@gnus.org> writes:

> Arash Esbati <arash@gnu.org> writes:
>
>> (loaddefs-generate "~/Test/"
>>                    "~/Test/autoload.el"
>>                    '("~/Test/input-ignore.el") nil nil t)
>>
>> autoloads from input-ignore.el aren't ignored.  Am I missing something?
>
> The excluded files weren't expanded.  I've now fixed this in Emacs 29.

Thanks for looking at this.  But it still doesn't work for with the
recipe I've posted in this message[1].  Does it work for you?  This is
with Emacs master 9d6d3b0edb.

Best, Arash

Footnotes:
[1]  https://lists.gnu.org/archive/html/bug-gnu-emacs/2022-08/msg01067.html

bug#57144: 29.0.50; Missing description for excluded files in docstring of loaddefs-generate

[Lars Ingebrigtsen]

Arash Esbati <arash@gnu.org> writes:

> Thanks for looking at this.  But it still doesn't work for with the
> recipe I've posted in this message[1].  Does it work for you?  This is
> with Emacs master 9d6d3b0edb.

No, there were further bugs in the exclusion logic.  Can you test again
now?

bug#57144: 29.0.50; Missing description for excluded files in docstring of loaddefs-generate

[Arash Esbati]

Lars Ingebrigtsen <larsi@gnus.org> writes:

> Arash Esbati <arash@gnu.org> writes:
>
>> Thanks for looking at this.  But it still doesn't work for with the
>> recipe I've posted in this message[1].  Does it work for you?  This is
>> with Emacs master 9d6d3b0edb.
>
> No, there were further bugs in the exclusion logic.  Can you test again
> now?

It seems to work now.  Thanks for the fix.

Best, Arash

bug#57144: 29.0.50; Missing description for excluded files in docstring of loaddefs-generate

[Lars Ingebrigtsen]

Arash Esbati <arash@gnu.org> writes:

> It seems to work now.  Thanks for the fix.

Thanks; I'm closing this bug report, then.