From b7e26952f0f6ee3061b9bb855e36dee8e1ea6bf4 Mon Sep 17 00:00:00 2001 From: Stefan Kangas Date: Thu, 30 May 2019 13:05:46 +0200 Subject: [PATCH] Fix TODO to convert defvar with leading '*' to defcustom * etc/TODO: Remove done TODO to remove '*' from defvar. * doc/misc/gnus.texi: Remove leading '*' from defvar example. * lisp/kermit.el (kermit-esc-char): Convert to defcustom. * lisp/desktop.el (desktop-header): * lisp/obsolete/cc-compat.el (c-indent-level) (c-brace-imaginary-offset, c-brace-offset, c-argdecl-indent) (c-label-offset, c-continued-statement-offset) (c-continued-brace-offset): Remove leading '*' from docstring. * lisp/progmodes/dcl-mode.el: Remove leading '*' from docstring in comment. * test/manual/cedet/tests/test.el: Add comment asking if example of defvar with leading '*' should be removed. (Bug#35994) (The previous commit is also for the same bug.) --- doc/misc/gnus.texi | 2 +- etc/TODO | 3 --- lisp/desktop.el | 2 +- lisp/kermit.el | 8 +++++++- lisp/obsolete/cc-compat.el | 14 +++++++------- lisp/progmodes/dcl-mode.el | 2 +- test/manual/cedet/tests/test.el | 1 + 7 files changed, 18 insertions(+), 14 deletions(-) diff --git a/doc/misc/gnus.texi b/doc/misc/gnus.texi index 17b1521f488..11ee62d5462 100644 --- a/doc/misc/gnus.texi +++ b/doc/misc/gnus.texi @@ -30451,7 +30451,7 @@ Below is a slightly shortened version of the @code{nndir} back end. nnml-current-directory nnmh-current-directory) (defvoo nndir-nov-is-evil nil - "*Non-nil means that nndir will never retrieve NOV headers." + "Non-nil means that nndir will never retrieve NOV headers." nnml-nov-is-evil) (defvoo nndir-current-group "" diff --git a/etc/TODO b/etc/TODO index 0f93279fa68..f8c2d285eef 100644 --- a/etc/TODO +++ b/etc/TODO @@ -122,9 +122,6 @@ It can use the same icons as gud. ** Check what minor modes don't use define-minor-mode and convert them to use it. -** Convert all defvars with leading '*' in the doc-strings into defcustoms -of appropriate :type and :group. - ** Remove unnecessary autoload cookies from defcustoms. This needs a bit of care, since often people have become used to expecting such variables to always be defined, eg when they modify diff --git a/lisp/desktop.el b/lisp/desktop.el index 33d7643d1b7..59610a128a3 100644 --- a/lisp/desktop.el +++ b/lisp/desktop.el @@ -616,7 +616,7 @@ DIRNAME omitted or nil means use `desktop-dirname'." ";; -------------------------------------------------------------------------- ;; Desktop File for Emacs ;; -------------------------------------------------------------------------- -" "*Header to place in Desktop file.") +" "Header to place in Desktop file.") (defvar desktop-delay-hook nil "Hooks run after all buffers are loaded; intended for internal use.") diff --git a/lisp/kermit.el b/lisp/kermit.el index f6ed1fbda1c..ec5d91749c4 100644 --- a/lisp/kermit.el +++ b/lisp/kermit.el @@ -77,7 +77,13 @@ (require 'shell) -(defvar kermit-esc-char "\C-\\" "*Kermit's escape char.") +(defgroup kermit nil + "Kermit support." + :group 'comm) + +(defcustom kermit-esc-char "\C-\\" + "Kermit's escape char." + :type 'string) (defun kermit-esc () "For sending escape sequences to a kermit running in shell mode." diff --git a/lisp/obsolete/cc-compat.el b/lisp/obsolete/cc-compat.el index bbacd121135..8e9d9e72625 100644 --- a/lisp/obsolete/cc-compat.el +++ b/lisp/obsolete/cc-compat.el @@ -59,21 +59,21 @@ ;; In case c-mode.el isn't loaded (defvar c-indent-level 2 - "*Indentation of C statements with respect to containing block.") + "Indentation of C statements with respect to containing block.") ;;;###autoload(put 'c-indent-level 'safe-local-variable 'integerp) (defvar c-brace-imaginary-offset 0 - "*Imagined indentation of a C open brace that actually follows a statement.") + "Imagined indentation of a C open brace that actually follows a statement.") (defvar c-brace-offset 0 - "*Extra indentation for braces, compared with other text in same context.") + "Extra indentation for braces, compared with other text in same context.") (defvar c-argdecl-indent 5 - "*Indentation level of declarations of C function arguments.") + "Indentation level of declarations of C function arguments.") (defvar c-label-offset -2 - "*Offset of C label lines and case statements relative to usual indentation.") + "Offset of C label lines and case statements relative to usual indentation.") (defvar c-continued-statement-offset 2 - "*Extra indent for lines not starting new statements.") + "Extra indent for lines not starting new statements.") (defvar c-continued-brace-offset 0 - "*Extra indent for substatements that start with open-braces. + "Extra indent for substatements that start with open-braces. This is in addition to c-continued-statement-offset.") diff --git a/lisp/progmodes/dcl-mode.el b/lisp/progmodes/dcl-mode.el index d5803c77bb4..864074fe191 100644 --- a/lisp/progmodes/dcl-mode.el +++ b/lisp/progmodes/dcl-mode.el @@ -459,7 +459,7 @@ Preloaded with all known option names from dcl-option-alist") ; ("GOSUB" (, (concat dcl-cmd-r ; "GOSUB[ \t]+\\([A-Za-z0-9_$]+\\)")) 5) ; ("CALL" (, (concat dcl-cmd-r "CALL[ \t]+\\([A-Za-z0-9_$]+\\)")) 5))) -; "*Default imenu generic expression for DCL. +; "Default imenu generic expression for DCL. ;The default includes SUBROUTINE labels in the main listing and ;sub-listings for other labels, CALL, GOTO and GOSUB statements. diff --git a/test/manual/cedet/tests/test.el b/test/manual/cedet/tests/test.el index 242186c3601..8f551da5fe7 100644 --- a/test/manual/cedet/tests/test.el +++ b/test/manual/cedet/tests/test.el @@ -83,6 +83,7 @@ (defvar a-defvar (cons 1 2) "Variable a") +;; FIXME: This practice is not recommended in recent Emacs. Remove? (defvar a-defvar-star (cons 1 2) "*User visible var a") -- 2.39.2