[Emacs-diffs] /srv/bzr/emacs/trunk r106506: Give some autoloaded things doc-strings.

[Glenn Morris]

------------------------------------------------------------
revno: 106506
committer: Glenn Morris <address@hidden>
branch nick: trunk
timestamp: Thu 2011-11-24 00:21:03 -0800
message:
  Give some autoloaded things doc-strings.
  
  * lisp/lpr.el (lpr-windows-system, lpr-lp-system):
  * lisp/mail/binhex.el (binhex-begin-line):
  * lisp/progmodes/grep.el (grep-history, grep-find-history):
  * lisp/textmodes/flyspell.el:
  * lisp/vc/pcvs-defs.el (cvs-global-menu):
  * lisp/vc/vc-bzr.el (vc-bzr-admin-checkout-format-file):
  * lisp/vc/vc-mtn.el (vc-mtn-admin-dir, vc-mtn-admin-format):
  * lisp/vc/vc-cvs.el (vc-cvs-registered): Give them basic doc-strings.
modified:
  lisp/ChangeLog
  lisp/lpr.el
  lisp/mail/binhex.el
  lisp/progmodes/grep.el
  lisp/textmodes/flyspell.el
  lisp/vc/pcvs-defs.el
  lisp/vc/vc-bzr.el
  lisp/vc/vc-cvs.el
  lisp/vc/vc-mtn.el

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2011-11-24 07:44:51 +0000
+++ b/lisp/ChangeLog    2011-11-24 08:21:03 +0000
@@ -1,5 +1,14 @@
 2011-11-24  Glenn Morris  <address@hidden>
 
+       * lpr.el (lpr-windows-system, lpr-lp-system):
+       * mail/binhex.el (binhex-begin-line):
+       * progmodes/grep.el (grep-history, grep-find-history):
+       * textmodes/flyspell.el:
+       * vc/pcvs-defs.el (cvs-global-menu):
+       * vc/vc-bzr.el (vc-bzr-admin-checkout-format-file):
+       * vc/vc-mtn.el (vc-mtn-admin-dir, vc-mtn-admin-format):
+       * vc/vc-cvs.el (vc-cvs-registered): Give them basic doc-strings.
+
        * net/tls.el: Fix case of "GnuTLS".
 
        * paths.el (rmail-file-name): Format doc-string for make-docfile.

=== modified file 'lisp/lpr.el'
--- a/lisp/lpr.el       2011-05-06 16:38:02 +0000
+++ b/lisp/lpr.el       2011-11-24 08:21:03 +0000
@@ -33,11 +33,13 @@
 
 ;;;###autoload
 (defvar lpr-windows-system
-  (memq system-type '(ms-dos windows-nt)))
+  (memq system-type '(ms-dos windows-nt))
+  "Non-nil if running on MS-DOS or MS Windows.")
 
 ;;;###autoload
 (defvar lpr-lp-system
-  (memq system-type '(usg-unix-v hpux irix)))
+  (memq system-type '(usg-unix-v hpux irix))
+  "Non-nil if running on a system type that uses the \"lp\" command.")
 
 
 (defgroup lpr nil

=== modified file 'lisp/mail/binhex.el'
--- a/lisp/mail/binhex.el       2011-01-25 04:08:28 +0000
+++ b/lisp/mail/binhex.el       2011-11-24 08:21:03 +0000
@@ -79,10 +79,11 @@
 
 ;;;###autoload
 (defconst binhex-begin-line
-  "^:...............................................................$")
+  "^:...............................................................$"
+  "Regular expression matching the start of a BinHex encoded region.")
 (defconst binhex-body-line
   "^[^:]...............................................................$")
-(defconst binhex-end-line ":$")
+(defconst binhex-end-line ":$")                ; unused
 
 (defvar binhex-temporary-file-directory
   (cond ((fboundp 'temp-directory) (temp-directory))

=== modified file 'lisp/progmodes/grep.el'
--- a/lisp/progmodes/grep.el    2011-11-15 07:55:13 +0000
+++ b/lisp/progmodes/grep.el    2011-11-24 08:21:03 +0000
@@ -438,9 +438,9 @@
 
 ;; History of grep commands.
 ;;;###autoload
-(defvar grep-history nil)
+(defvar grep-history nil "History list for grep.")
 ;;;###autoload
-(defvar grep-find-history nil)
+(defvar grep-find-history nil "History list for grep-find.")
 
 ;; History of lgrep and rgrep regexp and files args.
 (defvar grep-regexp-history nil)

=== modified file 'lisp/textmodes/flyspell.el'
--- a/lisp/textmodes/flyspell.el        2011-11-18 08:31:02 +0000
+++ b/lisp/textmodes/flyspell.el        2011-11-24 08:21:03 +0000
@@ -466,7 +466,7 @@
 ;;*---------------------------------------------------------------------*/
 ;;*    flyspell-mode ...                                                */
 ;;*---------------------------------------------------------------------*/
-;;;###autoload(defvar flyspell-mode nil)
+;;;###autoload(defvar flyspell-mode nil "Non-nil if Flyspell mode is enabled.")
 ;;;###autoload
 (define-minor-mode flyspell-mode
   "Toggle on-the-fly spell checking (Flyspell mode).

=== modified file 'lisp/vc/pcvs-defs.el'
--- a/lisp/vc/pcvs-defs.el      2011-11-17 09:09:20 +0000
+++ b/lisp/vc/pcvs-defs.el      2011-11-24 08:21:03 +0000
@@ -493,7 +493,8 @@
     (define-key m [examine]
       `(menu-item ,(purecopy "Examine Directory") cvs-examine
                  :help ,(purecopy "Examine the current state of a workarea")))
-    (fset 'cvs-global-menu m)))
+    (fset 'cvs-global-menu m))
+  "Global menu used by PCL-CVS.")
 
 
 ;; cvs-1.10 and above can take file arguments in other directories

=== modified file 'lisp/vc/vc-bzr.el'
--- a/lisp/vc/vc-bzr.el 2011-11-02 01:58:59 +0000
+++ b/lisp/vc/vc-bzr.el 2011-11-24 08:21:03 +0000
@@ -124,7 +124,8 @@
 ;; Used in the autoloaded vc-bzr-registered; see below.
 ;;;###autoload
 (defconst vc-bzr-admin-checkout-format-file
-  (concat vc-bzr-admin-dirname "/checkout/format"))
+  (concat vc-bzr-admin-dirname "/checkout/format")
+  "Name of the format file in a .bzr directory.")
 (defconst vc-bzr-admin-dirstate
   (concat vc-bzr-admin-dirname "/checkout/dirstate"))
 (defconst vc-bzr-admin-branch-format-file

=== modified file 'lisp/vc/vc-cvs.el'
--- a/lisp/vc/vc-cvs.el 2011-01-25 04:08:28 +0000
+++ b/lisp/vc/vc-cvs.el 2011-11-24 08:21:03 +0000
@@ -189,7 +189,8 @@
 ;;; State-querying functions
 ;;;
 
-;;;###autoload (defun vc-cvs-registered (f)
+;;;###autoload(defun vc-cvs-registered (f)
+;;;###autoload   "Return non-nil if file F is registered with CVS."
 ;;;###autoload   (when (file-readable-p (expand-file-name
 ;;;###autoload                           "CVS/Entries" (file-name-directory 
f)))
 ;;;###autoload       (load "vc-cvs")

=== modified file 'lisp/vc/vc-mtn.el'
--- a/lisp/vc/vc-mtn.el 2011-11-20 03:48:53 +0000
+++ b/lisp/vc/vc-mtn.el 2011-11-24 08:21:03 +0000
@@ -59,9 +59,10 @@
   (setq vc-handled-backends (delq 'Mtn vc-handled-backends)))
 
 ;;;###autoload
-(defconst vc-mtn-admin-dir "_MTN")
+(defconst vc-mtn-admin-dir "_MTN" "Name of the monotone directory.")
 ;;;###autoload
-(defconst vc-mtn-admin-format (concat vc-mtn-admin-dir "/format"))
+(defconst vc-mtn-admin-format (concat vc-mtn-admin-dir "/format")
+  "Name of the monotone directory's format file.")
 
 ;;;###autoload (defun vc-mtn-registered (file)
 ;;;###autoload   (if (vc-find-root file vc-mtn-admin-format)