bug#4664: 23.1.50; local variables completions

bug#4664: 23.1.50; local variables completions

[Leo]

Please describe exactly what actions triggered the bug
and the precise symptoms of the bug:

For example, completions in add-file-local-variable do not include local
variables such as auto-fill-function. Could this be improved?

Leo

bug#4664: 23.1.50; local variables completions

[Stefan Monnier]

> For example, completions in add-file-local-variable do not include local
> variables such as auto-fill-function. Could this be improved?

Thanks, I installed the patch below which should help,


        Stefan


=== modified file 'lisp/files-x.el'
--- lisp/files-x.el	2009-10-04 07:44:39 +0000
+++ lisp/files-x.el	2009-10-07 14:30:53 +0000
@@ -49,6 +49,7 @@
 	   obarray
 	   (lambda (sym)
 	     (or (user-variable-p sym)
+                 (get sym 'safe-local-variable)
 		 (memq sym '(mode eval coding unibyte))))
 	   nil nil nil default nil))
     (and (stringp variable) (intern variable))))

bug#4664: marked as done (23.1.50; local variables completions)

[Emacs bug Tracking System]

[-- Attachment #1: Type: text/plain, Size: 866 bytes --]

Your message dated Wed, 07 Oct 2009 22:06:34 +0100
with message-id <xbaipr8yncbp.fsf@cam.ac.uk>
and subject line Re: bug#4664: 23.1.50; local variables completions
has caused the Emacs bug report #4664,
regarding 23.1.50; local variables completions
to be marked as done.

This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
bug report if necessary, and/or fix the problem forthwith.

(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact owner@emacsbugs.donarmstrong.com
immediately.)


-- 
4664: http://emacsbugs.donarmstrong.com/cgi-bin/bugreport.cgi?bug=4664
Emacs Bug Tracking System
Contact owner@emacsbugs.donarmstrong.com with problems

[-- Attachment #2: Type: message/rfc822, Size: 2410 bytes --]

From: Leo <sdl.web@gmail.com>
To: emacs-pretest-bug@gnu.org
Subject: 23.1.50; local variables completions
Date: Wed, 07 Oct 2009 12:15:27 +0100
Message-ID: <m08wfn3168.fsf@cam.ac.uk>

Please describe exactly what actions triggered the bug
and the precise symptoms of the bug:

For example, completions in add-file-local-variable do not include local
variables such as auto-fill-function. Could this be improved?

Leo


[-- Attachment #3: Type: message/rfc822, Size: 2018 bytes --]

From: Leo <sdl.web@gmail.com>
To: Stefan Monnier <monnier@iro.umontreal.ca>
Cc: 4664-done@emacsbugs.donarmstrong.com
Subject: Re: bug#4664: 23.1.50; local variables completions
Date: Wed, 07 Oct 2009 22:06:34 +0100
Message-ID: <xbaipr8yncbp.fsf@cam.ac.uk>

On 2009-10-07 15:34 +0100, Stefan Monnier wrote:
>> For example, completions in add-file-local-variable do not include local
>> variables such as auto-fill-function. Could this be improved?
>
> Thanks, I installed the patch below which should help,
[-patch-]

Thank you.

Leo

bug#4664: 23.1.50; local variables completions

[Stefan Monnier]

> Thanks, this also added usually unbound symbols
> like `generated-autoload-file'.

Is that a problem?


        Stefan

bug#4664: 23.1.50; local variables completions

[Leo]

On 2009-10-08 02:10 +0100, Stefan Monnier wrote:
>> Thanks, this also added usually unbound symbols
>> like `generated-autoload-file'.
>
> Is that a problem?
>
>
>         Stefan

When trying to add generated-autoload-file it produces an error. So I
wonder if the following is more suitable?

(or (user-variable-sym)
    (and (boundp sym) (get sym 'safe-local-variable))
    (memq sym '(mode eval coding unibyte)))

-- 
Leo's Emacs uptime: 3 minutes, 20 seconds

bug#4664: 23.1.50; local variables completions

[Juri Linkov]

>>> Thanks, this also added usually unbound symbols
>>> like `generated-autoload-file'.
>>
>> Is that a problem?

No, no.  Some time ago I noticed that there are some unbound symbols
valid for inclusion to the Local Variables section but unavailable
for completion.  So far I had no idea about the correct way
to add them.  Your change fixed that.

> When trying to add generated-autoload-file it produces an error. So I
> wonder if the following is more suitable?
>
> (or (user-variable-sym)
>     (and (boundp sym) (get sym 'safe-local-variable))
>     (memq sym '(mode eval coding unibyte)))

This is a wrong fix.  It again removes valid local variables like
`generated-autoload-file' from completion.  The right fix would be
just to avoid trying to provide their current value as the default
value:

Index: lisp/files-x.el
===================================================================
RCS file: /sources/emacs/emacs/lisp/files-x.el,v
retrieving revision 1.4
diff -c -r1.4 files-x.el
*** lisp/files-x.el	7 Oct 2009 14:33:37 -0000	1.4
--- lisp/files-x.el	8 Oct 2009 09:21:22 -0000
***************
*** 92,98 ****
  			 nil 'set-variable-value-history
  			 (format "%S"
  				 (cond ((eq variable 'unibyte) t)
! 				       (t (symbol-value variable))))))))))
  
  (defun read-file-local-variable-mode ()
    "Read per-directory file-local variable's mode using completion.
--- 92,99 ----
  			 nil 'set-variable-value-history
  			 (format "%S"
  				 (cond ((eq variable 'unibyte) t)
! 				       ((boundp variable)
! 					(symbol-value variable))))))))))
  
  (defun read-file-local-variable-mode ()
    "Read per-directory file-local variable's mode using completion.

-- 
Juri Linkov
http://www.jurta.org/emacs/

bug#4664: 23.1.50; local variables completions

[Leo]

On 2009-10-08 10:22 +0100, Juri Linkov wrote:
> This is a wrong fix.  It again removes valid local variables like
> `generated-autoload-file' from completion.  The right fix would be
> just to avoid trying to provide their current value as the default
> value:
[-patch-]

Thank you for the patch.

Leo

bug#4664: 23.1.50; local variables completions

[Stefan Monnier]

> This is a wrong fix.  It again removes valid local variables like
> `generated-autoload-file' from completion.  The right fix would be
> just to avoid trying to provide their current value as the default
> value:

Agreed.  Actually even if a symbol is not known to be safe and not
completable, it should be possible for the user to use it, since it may
simply not be loaded yet.


        Stefan

bug#4664: 23.1.50; local variables completions

[Juri Linkov]

>> This is a wrong fix.  It again removes valid local variables like
>> `generated-autoload-file' from completion.  The right fix would be
>> just to avoid trying to provide their current value as the default
>> value:
>
> Agreed.  Actually even if a symbol is not known to be safe and not
> completable, it should be possible for the user to use it, since it may
> simply not be loaded yet.

Yes, this is already the case: the user is free to enter any variable.
It is only completion with require-match=nil that provides a list
of known variable names.

-- 
Juri Linkov
http://www.jurta.org/emacs/

bug#4664: 23.1.50; local variables completions

[Leo]

On 2009-10-12 00:54 +0100, Juri Linkov wrote:
>>> This is a wrong fix.  It again removes valid local variables like
>>> `generated-autoload-file' from completion.  The right fix would be
>>> just to avoid trying to provide their current value as the default
>>> value:
>>
>> Agreed.  Actually even if a symbol is not known to be safe and not
>> completable, it should be possible for the user to use it, since it may
>> simply not be loaded yet.
>
> Yes, this is already the case: the user is free to enter any variable.
> It is only completion with require-match=nil that provides a list
> of known variable names.

The completion of 'mode' does not include modes like outline-minor-mode.
Is this an oversight?

Leo

bug#4664: 23.1.50; local variables completions

[Juri Linkov]

>>>> This is a wrong fix.  It again removes valid local variables like
>>>> `generated-autoload-file' from completion.  The right fix would be
>>>> just to avoid trying to provide their current value as the default
>>>> value:
>>>
>>> Agreed.  Actually even if a symbol is not known to be safe and not
>>> completable, it should be possible for the user to use it, since it may
>>> simply not be loaded yet.
>>
>> Yes, this is already the case: the user is free to enter any variable.
>> It is only completion with require-match=nil that provides a list
>> of known variable names.
>
> The completion of 'mode' does not include modes like outline-minor-mode.
> Is this an oversight?

I've excluded minor modes from completion intentionally because the manual
says in (info "(emacs) Specifying File Variables"):

     You can use the `mode' "variable" to set minor modes as well as the
  major modes; in fact, you can use it more than once, first to set the
  major mode and then to set minor modes which are specific to particular
  buffers.  But most minor modes should not be specified in the file at
  all, because they represent user preferences.

I'm not sure about a list of minor modes that represent user preferences.
Where can I see a complete list of their names?  Since this is too vague,
perhaps we should include minor modes to the completion of 'mode'.

-- 
Juri Linkov
http://www.jurta.org/emacs/

bug#4664: 23.1.50; local variables completions

[Leo]

On 2009-10-12 21:31 +0100, Juri Linkov wrote:
[...]
>> The completion of 'mode' does not include modes like outline-minor-mode.
>> Is this an oversight?
>
> I've excluded minor modes from completion intentionally because the manual
> says in (info "(emacs) Specifying File Variables"):
>
>      You can use the `mode' "variable" to set minor modes as well as the
>   major modes; in fact, you can use it more than once, first to set the
>   major mode and then to set minor modes which are specific to particular
>   buffers.  But most minor modes should not be specified in the file at
>   all, because they represent user preferences.

I wonder if this is a bit silly. Whether it is user preferences should
be left for the users who are editing that file to decide. For example,
if Will Smith and I are editing the same file and I want to enable
outline-minor-mode in the local variables, I will consult him before
enabling it.

> I'm not sure about a list of minor modes that represent user preferences.
> Where can I see a complete list of their names?  Since this is too vague,
> perhaps we should include minor modes to the completion of 'mode'.

-- 
Leo's Emacs uptime: 17 minutes, 0 seconds

bug#4664: 23.1.50; local variables completions

[Stefan Monnier]

>> I've excluded minor modes from completion intentionally because the manual
>> says in (info "(emacs) Specifying File Variables"):

I'm not sure it's a good idea to remove them from completions.

>> You can use the `mode' "variable" to set minor modes as well as the
>> major modes; in fact, you can use it more than once, first to set the
>> major mode and then to set minor modes which are specific to particular
>> buffers.  But most minor modes should not be specified in the file at
>> all, because they represent user preferences.

> I wonder if this is a bit silly.

Which part is silly?  The above text simply describes things as they
stand, without forcing any particular choice.

> Whether it is user preferences should be left for the users who are
> editing that file to decide.

Which it is.  We simply added the note about minor modes (which is
actually not specific to minor modes, it also holds for many plain
variables), because it has been found to be a common misuse.

> For example, if Will Smith and I are editing the same file and I want
> to enable outline-minor-mode in the local variables, I will consult
> him before enabling it.

That's fine.  A very common situation is a file that you're the sole
author, so you put any random personal setting in there without having
to worry about asking Will.  And then you publish it on the web (e.g. it
could be an Elisp package), so anybody who opens it in Emacs gets your
preferences imposed on himself while viewing your file.

> Leo's Emacs uptime: 17 minutes, 0 seconds

17 minutes and counting... how's that for impressive?!


        Stefan

bug#4664: 23.1.50; local variables completions

[Juri Linkov]

>>> I've excluded minor modes from completion intentionally because the
>>> manual says in (info "(emacs) Specifying File Variables"):
>
> I'm not sure it's a good idea to remove them from completions.

Actually not a good idea.  I've lifted this restriction.

-- 
Juri Linkov
http://www.jurta.org/emacs/

bug#4664: 23.1.50; local variables completions

[Leo]

On 2009-10-13 23:35 +0100, Juri Linkov wrote:
>>>> I've excluded minor modes from completion intentionally because the
>>>> manual says in (info "(emacs) Specifying File Variables"):
>>
>> I'm not sure it's a good idea to remove them from completions.
>
> Actually not a good idea.  I've lifted this restriction.

Thank you.

Leo