Skip to content

Commit b7e2695

Browse files
skangasEli-Zaretskii
authored andcommitted
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.)
1 parent 8c4d114 commit b7e2695

File tree

7 files changed

+18
-14
lines changed

7 files changed

+18
-14
lines changed

doc/misc/gnus.texi

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30451,7 +30451,7 @@ Below is a slightly shortened version of the @code{nndir} back end.
3045130451
nnml-current-directory nnmh-current-directory)
3045230452

3045330453
(defvoo nndir-nov-is-evil nil
30454-
"*Non-nil means that nndir will never retrieve NOV headers."
30454+
"Non-nil means that nndir will never retrieve NOV headers."
3045530455
nnml-nov-is-evil)
3045630456

3045730457
(defvoo nndir-current-group ""

etc/TODO

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -122,9 +122,6 @@ It can use the same icons as gud.
122122
** Check what minor modes don't use define-minor-mode and convert them
123123
to use it.
124124

125-
** Convert all defvars with leading '*' in the doc-strings into defcustoms
126-
of appropriate :type and :group.
127-
128125
** Remove unnecessary autoload cookies from defcustoms.
129126
This needs a bit of care, since often people have become used to
130127
expecting such variables to always be defined, eg when they modify

lisp/desktop.el

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -616,7 +616,7 @@ DIRNAME omitted or nil means use `desktop-dirname'."
616616
";; --------------------------------------------------------------------------
617617
;; Desktop File for Emacs
618618
;; --------------------------------------------------------------------------
619-
" "*Header to place in Desktop file.")
619+
" "Header to place in Desktop file.")
620620

621621
(defvar desktop-delay-hook nil
622622
"Hooks run after all buffers are loaded; intended for internal use.")

lisp/kermit.el

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,13 @@
7777

7878
(require 'shell)
7979

80-
(defvar kermit-esc-char "\C-\\" "*Kermit's escape char.")
80+
(defgroup kermit nil
81+
"Kermit support."
82+
:group 'comm)
83+
84+
(defcustom kermit-esc-char "\C-\\"
85+
"Kermit's escape char."
86+
:type 'string)
8187

8288
(defun kermit-esc ()
8389
"For sending escape sequences to a kermit running in shell mode."

lisp/obsolete/cc-compat.el

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -59,21 +59,21 @@
5959

6060
;; In case c-mode.el isn't loaded
6161
(defvar c-indent-level 2
62-
"*Indentation of C statements with respect to containing block.")
62+
"Indentation of C statements with respect to containing block.")
6363
;;;###autoload(put 'c-indent-level 'safe-local-variable 'integerp)
6464

6565
(defvar c-brace-imaginary-offset 0
66-
"*Imagined indentation of a C open brace that actually follows a statement.")
66+
"Imagined indentation of a C open brace that actually follows a statement.")
6767
(defvar c-brace-offset 0
68-
"*Extra indentation for braces, compared with other text in same context.")
68+
"Extra indentation for braces, compared with other text in same context.")
6969
(defvar c-argdecl-indent 5
70-
"*Indentation level of declarations of C function arguments.")
70+
"Indentation level of declarations of C function arguments.")
7171
(defvar c-label-offset -2
72-
"*Offset of C label lines and case statements relative to usual indentation.")
72+
"Offset of C label lines and case statements relative to usual indentation.")
7373
(defvar c-continued-statement-offset 2
74-
"*Extra indent for lines not starting new statements.")
74+
"Extra indent for lines not starting new statements.")
7575
(defvar c-continued-brace-offset 0
76-
"*Extra indent for substatements that start with open-braces.
76+
"Extra indent for substatements that start with open-braces.
7777
This is in addition to c-continued-statement-offset.")
7878

7979

lisp/progmodes/dcl-mode.el

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -459,7 +459,7 @@ Preloaded with all known option names from dcl-option-alist")
459459
; ("GOSUB" (, (concat dcl-cmd-r
460460
; "GOSUB[ \t]+\\([A-Za-z0-9_$]+\\)")) 5)
461461
; ("CALL" (, (concat dcl-cmd-r "CALL[ \t]+\\([A-Za-z0-9_$]+\\)")) 5)))
462-
; "*Default imenu generic expression for DCL.
462+
; "Default imenu generic expression for DCL.
463463

464464
;The default includes SUBROUTINE labels in the main listing and
465465
;sub-listings for other labels, CALL, GOTO and GOSUB statements.

test/manual/cedet/tests/test.el

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@
8383
(defvar a-defvar (cons 1 2)
8484
"Variable a")
8585

86+
;; FIXME: This practice is not recommended in recent Emacs. Remove?
8687
(defvar a-defvar-star (cons 1 2)
8788
"*User visible var a")
8889

0 commit comments

Comments
 (0)