changeset 106017:660fd54d2835

(elint-standard-variables): Doc fix. Add some comments related to #1063.
author Glenn Morris <rgm@gnu.org>
date Sat, 14 Nov 2009 19:57:09 +0000
parents 042d5d78d053
children 227bcb572dbe
files lisp/ChangeLog lisp/emacs-lisp/elint.el
diffstat 2 files changed, 15 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/lisp/ChangeLog	Sat Nov 14 19:55:37 2009 +0000
+++ b/lisp/ChangeLog	Sat Nov 14 19:57:09 2009 +0000
@@ -1,3 +1,7 @@
+2009-11-14  Glenn Morris  <rgm@gnu.org>
+
+	* emacs-lisp/elint.el (elint-standard-variables): Doc fix.
+
 2009-11-14  Shigeru Fukaya  <shigeru.fukaya@gmail.com>
 
 	* emacs-lisp/elint.el (elint-standard-variables): Add some variables
--- a/lisp/emacs-lisp/elint.el	Sat Nov 14 19:55:37 2009 +0000
+++ b/lisp/emacs-lisp/elint.el	Sat Nov 14 19:57:09 2009 +0000
@@ -118,13 +118,15 @@
 ;;; Data
 ;;;
 
-;; FIXME does this serve any useful purpose now elint-builtin-variables exists?
 (defconst elint-standard-variables
+  ;; Most of these are defined in C with no documentation.
+  ;; FIXME I don't see why they shouldn't just get doc-strings.
   '(vc-mode local-write-file-hooks activate-menubar-hook buffer-name-history
 	    coding-system-history extended-command-history
 	    kbd-macro-termination-hook read-expression-history
 	    yes-or-no-p-history)
-  "Standard buffer local variables, excluding `elint-builtin-variables'.")
+  "Standard variables, excluding `elint-builtin-variables'.
+These are variables that we cannot detect automatically for some reason.")
 
 (defvar elint-builtin-variables nil
   "List of built-in variables.  Set by `elint-initialize'.
@@ -638,6 +640,13 @@
 
 (defun elint-unbound-variable (var env)
   "T if VAR is unbound in ENV."
+  ;; #1063 suggests adding (symbol-file var) here, but I don't think
+  ;; this is right, because it depends on what files you happen to have
+  ;; loaded at the time, which might not be the same when the code runs.
+  ;; It also suggests adding:
+  ;; (numberp (get var 'variable-documentation))
+  ;; (numberp (cdr-safe (get var 'variable-documentation)))
+  ;; but this is not needed now elint-scan-doc-file exists.
   (not (or (memq var '(nil t))
 	   (eq var elint-bound-variable)
 	   (elint-env-find-var env var)