* paths.el (rmail-file-name): Reformat the doc-string so that it is picked up.
authorGlenn Morris <rgm@gnu.org>
Wed, 23 Nov 2011 08:48:07 +0000 (00:48 -0800)
committerGlenn Morris <rgm@gnu.org>
Wed, 23 Nov 2011 08:48:07 +0000 (00:48 -0800)
lisp/ChangeLog
lisp/paths.el

index 9cf50d4..896d08e 100644 (file)
@@ -4,6 +4,9 @@
 
 2011-11-23  Glenn Morris  <rgm@gnu.org>
 
+       * paths.el (rmail-file-name): Reformat the doc-string so that it
+       is picked up.
+
        * mail/rmail.el (rmail-message-filter, rmail-auto-file): Doc fixes.
        (rmail-auto-file): Ignore case in the "special" field names,
        as mail-fetch-field does for all others.
index 161caf9..c608fd9 100644 (file)
@@ -132,8 +132,12 @@ should be set to `(system-name)'.")
 *The name of your organization, as a string.
 The `ORGANIZATION' environment variable is used instead if defined.")
 
-(defcustom rmail-file-name (purecopy "~/RMAIL") "\
-Name of user's primary mail file."
+;; This is a defcustom, which make-docfile does not recognize in
+;; uncompiled Lisp code.  If we use the "\ method of writing the doc,
+;; it does not get a doc string.  Somehow if we write it in the "wrong"
+;; (ie normal) way (as below), it does...  See also remote-shell-program.
+(defcustom rmail-file-name (purecopy "~/RMAIL")
+  "Name of user's primary mail file."
   :type 'string
   :group 'rmail
   :version "21.1")