branch: externals/debbugs
commit fe694f77c49f86952a698d13865867dec87aea39
Author: Morgan Smith <morgan.j.sm...@outlook.com>
Commit: Michael Albinus <michael.albi...@gmx.de>
Makefile: Add target to run checkdoc on all files
* Makefile: Add target to run checkdoc on all files.
* resources/debbugs-checkdoc-config.el: New file.
---
Makefile | 5 +++-
resources/debbugs-checkdoc-config.el | 50 ++++++++++++++++++++++++++++++++++++
2 files changed, 54 insertions(+), 1 deletion(-)
diff --git a/Makefile b/Makefile
index 81d7b5d2f2..da0764ea36 100644
--- a/Makefile
+++ b/Makefile
@@ -11,7 +11,7 @@ TESTTARGET=$(patsubst %.el,%.elc,$(TESTSOURCE))
INFOMANUALS=debbugs.info debbugs-ug.info
-.PHONY: all build check clean
+.PHONY: all build check clean checkdoc
.PRECIOUS: %.elc
%.elc: %.el
@@ -29,6 +29,9 @@ doc: $(INFOMANUALS)
build: $(TARGET)
+checkdoc: $(SOURCE) $(TESTSOURCE)
+ @$(EMACS) -Q --batch -l resources/debbugs-checkdoc-config.el $(foreach
file,$^,"--eval=(checkdoc-file \"$(file)\")")
+
check: build $(TESTTARGET)
@$(EMACS) -Q --batch -L . -L ./test $(foreach file,$(TESTSOURCE), -l
$(file)) --eval '(ert-run-tests-batch-and-exit "$(TESTS)")'
diff --git a/resources/debbugs-checkdoc-config.el
b/resources/debbugs-checkdoc-config.el
new file mode 100644
index 0000000000..d09b1adfe5
--- /dev/null
+++ b/resources/debbugs-checkdoc-config.el
@@ -0,0 +1,50 @@
+;;; debbugs-checkdoc-config.el --- Configuration for running checkdoc on
debbugs -*- lexical-binding: t; -*-
+
+;; Copyright (C) 2025 Free Software Foundation, Inc.
+
+;; Author: Morgan Smith <morgan.j.sm...@outlook.com>
+;; Package: debbugs
+
+;; This file is not part of GNU Emacs.
+
+;; This program is free software: you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
+
+;;; Commentary:
+
+;;; Code:
+
+(defvar checkdoc-package-keywords-flag)
+(defvar checkdoc-spellcheck-documentation-flag)
+(defvar checkdoc-ispell-lisp-words)
+
+(with-eval-after-load "checkdoc"
+ (setq checkdoc-package-keywords-flag t)
+ (setq checkdoc-spellcheck-documentation-flag t)
+ (setq checkdoc-ispell-lisp-words
+ '("ChangeLog" "ChangeLogs" "UTF" "alist" "args"
+ "armstrong" "backend" "bcc" "bugreport" "cdate" "cedet"
+ "coreutils" "cygwin" "debbugs" "debian" "el" "emacs"
+ "etags" "freemail" "fsf" "guix" "gw" "henoch" "hu"
+ "hyperestraier" "keymap" "magit" "magnus" "maint"
+ "maintainer" "maintainer's" "mbox" "mboxes" "minibuffer"
+ "moreinfo" "multibyte" "notabug" "paren" "persistency"
+ "regexp" "rescan" "rgm" "rmail" "severities" "sexp"
+ "solaris" "src" "sublist" "submitter" "submitter's"
+ "subproduct" "subqueries" "subquery" "teardown"
+ "unarchived" "unibyte" "unreproducible" "url" "util"
+ "wishlist" "wontfix" "wsdl" "www" "xsd" "zltuz")))
+
+(provide 'debbugs-checkdoc-config)
+
+;;; debbugs-checkdoc-config.el ends here
