[Emacs-diffs] /srv/bzr/emacs/trunk r106489: * paths.el (rmail-file-name): Reformat the doc-string so that it is picked up.

[Glenn Morris]

------------------------------------------------------------
revno: 106489
committer: Glenn Morris <address@hidden>
branch nick: trunk
timestamp: Wed 2011-11-23 00:48:07 -0800
message:
  * paths.el (rmail-file-name): Reformat the doc-string so that it is picked up.
modified:
  lisp/ChangeLog
  lisp/paths.el

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2011-11-23 08:29:08 +0000
+++ b/lisp/ChangeLog    2011-11-23 08:48:07 +0000
@@ -4,6 +4,9 @@
 
 2011-11-23  Glenn Morris  <address@hidden>
 
+       * 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.

=== modified file 'lisp/paths.el'
--- a/lisp/paths.el     2011-01-25 04:08:28 +0000
+++ b/lisp/paths.el     2011-11-23 08:48:07 +0000
@@ -132,8 +132,12 @@
 *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")