mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-07 23:10:28 -08:00
Code Issues Projects Releases Wiki Activity

Fix documentation and error message of adding local variables

Browse source 
* lisp/files-x.el (add-file-local-variable)
(add-file-local-variable-prop-line): Doc fixes.
(add-file-local-variable): Improve the user-error text.  (Bug#74267)
This commit is contained in:
Eli Zaretskii 2024-11-09 14:02:06 +02:00
parent 94bf7ad797
commit dbcd9d782c
1 changed files with 15 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

22
lisp/files-x.el
View file

@ -239,18 +239,23 @@ This command deletes all existing settings of VARIABLE (except `mode'
and `eval') and adds a new file-local VARIABLE with VALUE to the and `eval') and adds a new file-local VARIABLE with VALUE to the
Local Variables list. Local Variables list.
If there is no Local Variables list in the current file buffer If there is no Local Variables list in the current file buffer,
then this function adds the first line containing the string then this function adds it at the end of the file, with the first
`Local Variables:' and the last line containing the string `End:'." line containing the string `Local Variables:' and the last line
containing the string `End:'.
For adding local variables on the first line of a file, for example
for settings like `lexical-binding, which must be specified there,
use the `add-file-local-variable-prop-line' command instead."
(interactive (interactive
(let ((variable (read-file-local-variable "Add file-local variable"))) (let ((variable (read-file-local-variable "Add file-local variable")))
;; Error before reading value. ;; Error before reading value.
(if (equal variable 'lexical-binding) (if (equal variable 'lexical-binding)
(user-error "The `%s' variable must be set at the start of the file" (user-error "Use `add-file-local-variable-prop-line' to add the `%s' variable"
variable)) variable))
(list variable (read-file-local-variable-value variable) t))) (list variable (read-file-local-variable-value variable) t)))
(if (equal variable 'lexical-binding) (if (equal variable 'lexical-binding)
(user-error "The `%s' variable must be set at the start of the file" (user-error "Use `add-file-local-variable-prop-line' to add the `%s' variable"
variable)) variable))
(modify-file-local-variable variable value 'add-or-replace interactive)) (modify-file-local-variable variable value 'add-or-replace interactive))
@ -394,10 +399,13 @@ from the -*- line ignoring the input argument VALUE."
This command deletes all existing settings of VARIABLE (except `mode' This command deletes all existing settings of VARIABLE (except `mode'
and `eval') and adds a new file-local VARIABLE with VALUE to and `eval') and adds a new file-local VARIABLE with VALUE to
the -*- line. the -*- line at the beginning of the file.
If there is no -*- line at the beginning of the current file buffer If there is no -*- line at the beginning of the current file buffer
then this function adds it." then this function adds it.
To add variables to the Local Variables list at the end of the file,
use the `add-file-local-variable' command instead."
(interactive (interactive
(let ((variable (read-file-local-variable "Add -*- file-local variable"))) (let ((variable (read-file-local-variable "Add -*- file-local variable")))
(list variable (read-file-local-variable-value variable) t))) (list variable (read-file-local-variable-value variable) t)))