aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPhillip Lord2016-01-07 11:39:03 +0000
committerPhillip Lord2016-01-07 11:39:03 +0000
commit269d0088a89806f527180aba6fe23860ae916623 (patch)
tree41a930a55a9a8ffdcb6a2b2cc0df264d934d4337
parent07442debd1e037094700d1e5092ad72cdbb7d10d (diff)
downloademacs-269d0088a89806f527180aba6fe23860ae916623.tar.gz
emacs-269d0088a89806f527180aba6fe23860ae916623.zip
; Improve docstring for `inhibit-startup-echo-area-message'
Both the docstring and comments now indicate why this variable has specialised treatment.
-rw-r--r--lisp/startup.el21
1 files changed, 16 insertions, 5 deletions
diff --git a/lisp/startup.el b/lisp/startup.el
index 61f6db74f2e..aaa6883bd58 100644
--- a/lisp/startup.el
+++ b/lisp/startup.el
@@ -76,13 +76,24 @@ once you are familiar with the contents of the startup screen."
76 76
77(defvar startup-screen-inhibit-startup-screen nil) 77(defvar startup-screen-inhibit-startup-screen nil)
78 78
79;; FIXME? Why does this get such weirdly extreme treatment, when the 79;; The mechanism uses to ensure that only end users can disable this
80;; more important inhibit-startup-screen does not. 80;; message is not complex. Clearly, it is possible for a determined
81;; system administrator to inhibit this message anyway, but at least
82;; they will do so with knowledge of why the Emacs developers think
83;; this is a bad idea.
81(defcustom inhibit-startup-echo-area-message nil 84(defcustom inhibit-startup-echo-area-message nil
82 "Non-nil inhibits the initial startup echo area message. 85 "Non-nil inhibits the initial startup echo area message.
83Setting this variable takes effect 86
84only if you do it with the customization buffer 87The startup message in the echo area as it provides information
85or if your init file contains a line of this form: 88about GNU Emacs and the GNU system in general, which we want all
89users to see. As this is the least intrusive startup message,
90this variable gets specialized treatment to prevent the message
91from being disabled site-wide by systems administrators, while
92still allowing individual users to do so.
93
94Setting this variable takes effect only if you do it with the
95customization buffer or if your init file contains a line of this
96form:
86 (setq inhibit-startup-echo-area-message \"YOUR-USER-NAME\") 97 (setq inhibit-startup-echo-area-message \"YOUR-USER-NAME\")
87If your init file is byte-compiled, use the following form 98If your init file is byte-compiled, use the following form
88instead: 99instead: