summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorUlrich Müller <ulm@gentoo.org>2022-05-10 21:26:06 +0200
committerUlrich Müller <ulm@gentoo.org>2022-05-10 21:26:06 +0200
commit57611de17744f52bb230a034e5a57eedb6e9b137 (patch)
treebb2769b8f1e3d687ce43195bc2d48014e0549d4c
parentFix package keywords and docstrings (diff)
downloadebuild-mode-57611de17744f52bb230a034e5a57eedb6e9b137.tar.gz
ebuild-mode-57611de17744f52bb230a034e5a57eedb6e9b137.tar.bz2
ebuild-mode-57611de17744f52bb230a034e5a57eedb6e9b137.zip
Warn about some eclass documentation keywords
* ebuild-mode-keywords.el (ebuild-mode-keywords-eclassdoc-warn): New variable. (ebuild-mode-keywords-eclass-documentation): Move @DEAD and @DEPRECATED keywords to it. * ebuild-mode.el (ebuild-mode-font-lock-keywords): Use it. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
-rw-r--r--ChangeLog8
-rw-r--r--ebuild-mode-keywords.el17
-rw-r--r--ebuild-mode.el3
3 files changed, 22 insertions, 6 deletions
diff --git a/ChangeLog b/ChangeLog
index 0a6f218..ed3f1ae 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2022-05-10 Ulrich Müller <ulm@gentoo.org>
+
+ * ebuild-mode-keywords.el (ebuild-mode-keywords-eclassdoc-warn):
+ New variable.
+ (ebuild-mode-keywords-eclass-documentation): Move @DEAD and
+ @DEPRECATED keywords to it.
+ * ebuild-mode.el (ebuild-mode-font-lock-keywords): Use it.
+
2022-05-08 Ulrich Müller <ulm@gentoo.org>
* devbook-mode.el: Drop unknown package keyword "XML".
diff --git a/ebuild-mode-keywords.el b/ebuild-mode-keywords.el
index 3dec47d..2cec51c 100644
--- a/ebuild-mode-keywords.el
+++ b/ebuild-mode-keywords.el
@@ -89,14 +89,21 @@
;; Eclass keywords
(defvar ebuild-mode-keywords-eclass-documentation
- '(("@AUTHOR" "@BLURB" "@BUGREPORTS" "@CODE" "@DEAD" "@DEFAULT_UNSET"
- "@DEPRECATED" "@DESCRIPTION" "@ECLASS" "@ECLASS_VARIABLE" "@EXAMPLE"
- "@FUNCTION" "@INTERNAL" "@MAINTAINER" "@OUTPUT_VARIABLE" "@PRE_INHERIT"
- "@PROVIDES" "@REQUIRED" "@RETURN" "@ROFF" "@SUBSECTION"
- "@SUPPORTED_EAPIS" "@USAGE" "@USER_VARIABLE" "@VARIABLE" "@VCSURL")
+ '(("@AUTHOR" "@BLURB" "@BUGREPORTS" "@CODE" "@DEFAULT_UNSET" "@DESCRIPTION"
+ "@ECLASS" "@ECLASS_VARIABLE" "@EXAMPLE" "@FUNCTION" "@INTERNAL"
+ "@MAINTAINER" "@OUTPUT_VARIABLE" "@PRE_INHERIT" "@PROVIDES" "@REQUIRED"
+ "@RETURN" "@ROFF" "@SUBSECTION" "@SUPPORTED_EAPIS" "@USAGE"
+ "@USER_VARIABLE" "@VARIABLE" "@VCSURL")
(1 font-lock-type-face t)
"^# "))
+(defvar ebuild-mode-keywords-eclassdoc-warn
+ ;; @ECLASS-VARIABLE (with a hyphen) is deprecated:
+ ;; https://bugs.gentoo.org/835396
+ '(("@DEAD" "@DEPRECATED" "@ECLASS-VARIABLE")
+ (1 font-lock-warning-face t)
+ "^# "))
+
;; The list of eclass function keywords below is auto-generated
;; by keyword-generation.sh. This variable is special as the keyword
;; list is split into several parts, in order not to exceed the maximum
diff --git a/ebuild-mode.el b/ebuild-mode.el
index 647b27e..33c3dab 100644
--- a/ebuild-mode.el
+++ b/ebuild-mode.el
@@ -270,7 +270,8 @@ Optional argument LIMIT restarts collection after that number of elements."
ebuild-mode-keywords-sandbox
ebuild-mode-keywords-eapi-deprecated
ebuild-mode-keywords-warn
- ebuild-mode-keywords-eclass-documentation))
+ ebuild-mode-keywords-eclass-documentation
+ ebuild-mode-keywords-eclassdoc-warn))
ebuild-mode-keywords-eclass))))
;;; Mode definitions.