(checkdoc-this-string-valid-engine):

Don't encourage naming variables with "-flag".

2 files changed, 26 insertions, 18 deletions

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 4dca3ca7d5b..59d10082e62 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,8 @@
+2008-05-30  Stefan Monnier  <monnier@iro.umontreal.ca>
+
+        * emacs-lisp/checkdoc.el (checkdoc-this-string-valid-engine):
+        Don't encourage naming variables with "-flag".
+
 2008-05-30  Glenn Morris  <rgm@gnu.org>
 
         * Makefile.in (update-elclist): Hide the warning when it does not apply,
diff --git a/lisp/emacs-lisp/checkdoc.el b/lisp/emacs-lisp/checkdoc.el
index 8da93b7a327..de23111754a 100644
--- a/lisp/emacs-lisp/checkdoc.el
+++ b/lisp/emacs-lisp/checkdoc.el
@@ -1636,25 +1636,28 @@ function,command,variable,option or symbol." ms1))))))
                  (checkdoc-create-error
                   "Flag variable doc strings should usually start: Non-nil means"
                   s (marker-position e) t))
+             ;; Don't rename variable to "foo-flag".  This is unnecessary
+             ;; and such names often end up inconvenient when the variable
+             ;; is later expanded to non-boolean values. --Stef
              ;; If the doc string starts with "Non-nil means"
-             (if (and (looking-at "\"\\*?Non-nil\\s-+means\\s-+")
-                      (not (string-match "-flag$" (car fp))))
-                 (let ((newname
-                        (if (string-match "-p$" (car fp))
-                            (concat (substring (car fp) 0 -2) "-flag")
-                          (concat (car fp) "-flag"))))
-                   (if (checkdoc-y-or-n-p
-                        (format
-                         "Rename to %s and Query-Replace all occurrences? "
-                         newname))
-                       (progn
-                         (beginning-of-defun)
-                         (query-replace-regexp
-                          (concat "\\<" (regexp-quote (car fp)) "\\>")
-                          newname))
-                     (checkdoc-create-error
-                      "Flag variable names should normally end in `-flag'" s
-                      (marker-position e)))))
+             ;; (if (and (looking-at "\"\\*?Non-nil\\s-+means\\s-+")
+             ;;          (not (string-match "-flag$" (car fp))))
+             ;;     (let ((newname
+             ;;         (if (string-match "-p$" (car fp))
+             ;;             (concat (substring (car fp) 0 -2) "-flag")
+             ;;           (concat (car fp) "-flag"))))
+             ;;       (if (checkdoc-y-or-n-p
+             ;;         (format
+             ;;          "Rename to %s and Query-Replace all occurrences? "
+             ;;          newname))
+             ;;           (progn
+             ;;          (beginning-of-defun)
+             ;;          (query-replace-regexp
+             ;;           (concat "\\<" (regexp-quote (car fp)) "\\>")
+             ;;           newname))
+             ;;         (checkdoc-create-error
+             ;;          "Flag variable names should normally end in `-flag'" s
+             ;;          (marker-position e)))))
              ;; Done with variables
              ))
            (t