procyberian/emacs
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

checkdoc: Relax footer line check for recent Emacs

Browse source 
* lisp/emacs-lisp/checkdoc.el (checkdoc-file-comments-engine):
Don't require a footer line unless 'lm-package-needs-footer-line'
returns true.
This commit is contained in:
Stefan Kangas 2024-07-06 17:36:30 +02:00
parent 3cde006699
commit d826240fa5
2 changed files with 44 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

39
lisp/emacs-lisp/checkdoc.el
View file

@ -2476,21 +2476,30 @@ Code:, and others referenced in the style guide."
;; * Library footer
(save-excursion
(goto-char (point-max))
(if (not (re-search-backward
;; This should match the requirement in
;; `package-buffer-info'.
(concat "^;;; " (regexp-quote (concat fn fe)) " ends here")
nil t))
(if (checkdoc-y-or-n-p "No identifiable footer! Add one?")
(progn
(goto-char (point-max))
(insert "\n(provide '" fn ")\n\n;;; " fn fe " ends here\n"))
(checkdoc-create-error
(format "The footer should be: (provide '%s)\\n;;; %s%s ends here"
fn fn fe)
;; The buffer may be empty.
(max (point-min) (1- (point-max)))
(point-max)))))
(let* ((footer-line (lm-package-needs-footer-line)))
(if (not (re-search-backward
;; This should match the requirement in
;; `package-buffer-info'.
(if footer-line
(concat "^;;; " (regexp-quote (concat fn fe)) " ends here")
(concat "\n(provide '" fn ")\n"))
nil t))
(if (checkdoc-y-or-n-p (if footer-line
"No identifiable footer! Add one?"
"No `provide' statement! Add one?"))
(progn
(goto-char (point-max))
(insert (if footer-line
(concat "\n(provide '" fn ")\n\n;;; " fn fe " ends here\n")
(concat "\n(provide '" fn ")\n"))))
(checkdoc-create-error
(if footer-line
(format "The footer should be: (provide '%s)\\n;;; %s%s ends here"
fn fn fe)
(format "The footer should be: (provide '%s)\\n" fn))
;; The buffer may be empty.
(max (point-min) (1- (point-max)))
(point-max))))))
err))
;; The below checks will not return errors if the user says NO