From: Glenn Morris <rgm@gnu.org>
Date: Wed, 23 Nov 2011 08:48:07 +0000 (-0800)
Subject: * paths.el (rmail-file-name): Reformat the doc-string so that it is picked up.
X-Git-Tag: emacs-pretest-24.0.92~72
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=da94eca12f45cc4d22f3a7f6febfd94b87359bbe;p=emacs.git

* paths.el (rmail-file-name): Reformat the doc-string so that it is picked up.
---

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 9cf50d4c00b..896d08ea163 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -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.
diff --git a/lisp/paths.el b/lisp/paths.el
index 161caf9cb8c..c608fd98993 100644
--- a/lisp/paths.el
+++ b/lisp/paths.el
@@ -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")