procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

; Clarify what time-stamp-active enables

Browse source 
Fix documentation strings and comments for time-stamp.  Most notably:
* lisp/time-stamp.el (time-stamp-active): in the doc string, clarify
that time-stamp-active does not add time-stamp to any hook.
This commit is contained in:
Stephen Gildea 2020-01-24 09:15:44 -08:00
parent 0bed550e21
commit fd09196781
1 changed files with 15 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
lisp/time-stamp.el
View file

@ -94,6 +94,13 @@ edited by older versions of Emacs also, do not use this format yet."
(defcustom time-stamp-active t (defcustom time-stamp-active t
"Non-nil to enable time-stamping of buffers by \\[time-stamp]. "Non-nil to enable time-stamping of buffers by \\[time-stamp].
Can be toggled by \\[time-stamp-toggle-active]. Can be toggled by \\[time-stamp-toggle-active].
This option does not affect when `time-stamp' is run, only what it
does when it runs. To activate automatic time-stamping of buffers
when they are saved, either add this line to your init file:
(add-hook \\='before-save-hook \\='time-stamp)
or customize option `before-save-hook'.
See also the variable `time-stamp-warn-inactive'." See also the variable `time-stamp-warn-inactive'."
:type 'boolean :type 'boolean
:group 'time-stamp) :group 'time-stamp)
@ -269,7 +276,7 @@ time-stamped file itself.")
A template in a file can be automatically updated with a new time stamp A template in a file can be automatically updated with a new time stamp
every time you save the file. Add this line to your init file: every time you save the file. Add this line to your init file:
(add-hook \\='before-save-hook \\='time-stamp) (add-hook \\='before-save-hook \\='time-stamp)
or customize `before-save-hook' through Custom. or customize option `before-save-hook'.
Normally the template must appear in the first 8 lines of a file and Normally the template must appear in the first 8 lines of a file and
look like one of the following: look like one of the following:
Time-stamp: <> Time-stamp: <>
@ -606,24 +613,24 @@ and all `time-stamp-format' compatibility."
((eq cur-char ?F) ;buffer-file-name, full path ((eq cur-char ?F) ;buffer-file-name, full path
(or buffer-file-name (or buffer-file-name
time-stamp-no-file)) time-stamp-no-file))
((eq cur-char ?s) ;system name ((eq cur-char ?s) ;system name, legacy
(system-name)) (system-name))
((eq cur-char ?u) ;user name ((eq cur-char ?u) ;user name, legacy
(user-login-name)) (user-login-name))
((eq cur-char ?U) ;user full name ((eq cur-char ?U) ;user full name, legacy
(user-full-name)) (user-full-name))
((eq cur-char ?l) ;logname (undocumented user name alt) ((eq cur-char ?l) ;login name
(user-login-name)) (user-login-name))
((eq cur-char ?L) ;(undocumented alt user full name) ((eq cur-char ?L) ;full name of logged-in user
(user-full-name)) (user-full-name))
((eq cur-char ?h) ;mail host name ((eq cur-char ?h) ;mail host name
(or mail-host-address (system-name))) (or mail-host-address (system-name)))
((eq cur-char ?q) ;(undocumented unqual hostname) ((eq cur-char ?q) ;unqualified host name
(let ((qualname (system-name))) (let ((qualname (system-name)))
(if (string-match "\\." qualname) (if (string-match "\\." qualname)
(substring qualname 0 (match-beginning 0)) (substring qualname 0 (match-beginning 0))
qualname))) qualname)))
((eq cur-char ?Q) ;(undocumented fully-qualified host) ((eq cur-char ?Q) ;fully-qualified host name
(system-name)) (system-name))
)) ))
(and (numberp field-result) (and (numberp field-result)