From: Eli Zaretskii <eliz@gnu.org>
To: Kaushal Modi <kaushal.modi@gmail.com>
Cc: emacs-devel@gnu.org
Subject: Re: Relics of removed dir-locals-file-2 feature in pretest
Date: Mon, 27 Nov 2017 18:14:57 +0200 [thread overview]
Message-ID: <83r2sj66m6.fsf@gnu.org> (raw)
In-Reply-To: <CAFyQvY2fx-HfsXbwcH9Xca1cTSsupm6eSwd5h-85nOdEB7EEbg@mail.gmail.com> (message from Kaushal Modi on Mon, 27 Nov 2017 14:57:26 +0000)
> From: Kaushal Modi <kaushal.modi@gmail.com>
> Date: Mon, 27 Nov 2017 14:57:26 +0000
> Cc: emacs-devel@gnu.org
>
> Let's say a user reads the NEWS and finds:
>
> > * A second dir-local file (.dir-locals-2.el) is now accepted.
> > See the variable 'dir-locals-file-2' for more information.
>
> They do C-h v dir-locals-file-2 and read:
>
> > This essentially a second file that can be used like `dir-locals-file', ..
>
> That is incorrect! dir-locals-file-2 *cannot* be used like `dir-locals-file'! That variable is just declared but not
> used anywhere (why is it that only I think that that's a problem). A user can
The "second file" is .dir-locals-2.el, i.e. the value.
> Reading further in that docstring:
>
> > See Info node `(elisp)Directory Local Variables' for details.
>
> That node has no reference to dir-locals-file-2 variable or a mention of the feature that .dir-locals-2.el can be
> used to override .dir-local.el.
So maybe we need to add that to the manual.
> Also in the doc-string of dir-locals-file:
>
> > See also `dir-locals-file-2', whose values override this one's.
>
> No, it *does not*! dir-locals-file-2 is not used in any code.
But its (constant) value does override, doesn't it?
> Thank you for volunteering, but I'm not yet sure we should do that.
>
> Please consider making this change.
Which change? You are arguing about multiple issues, and I'm confused
about what change do you have in mind, exactly.
> From your earlier email (I missed replying to this part):
>
> > We could remove the defconst, but just removing it is not enough,
> > because that would also remove its doc string.
>
> Why is that bad?
Because iut's the only place where .dir-locals-2.el is documented.
> That variable is anyways not used.. so what's the point of keeping docstring of an unused
> variable.
The doc string documents a feature. If you remove the doc string and
do nothing else, where will that feature be documented?
> Why not just mention that a user can just add "-2" to (file-name-sans-extension dir-locals-file), and that file can
> be used to override dir-locals-file. Mention that in the dir-locals-file docstring and the (elisp)Directory Local
> Variables node.
That might work. As I said, just removing the defconst is not enough.
> The documentation is broken. It is incorrect, misleading.
Then let's fix the documentation.
> And I am not just complaining, I am willing to provide a patch that removes that defconst and updates the
> dir-local-file doc-string and the manual to make this feature better discoverable. So why is that is problem?
I didn't say it was a problem, you misunderstood what I said. Feel
free to submit such a patch, and thanks in advance.
next prev parent reply other threads:[~2017-11-27 16:14 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-10-12 13:58 Relics of removed dir-locals-file-2 feature in pretest Kaushal Modi
2017-11-21 19:56 ` Kaushal Modi
2017-11-21 20:33 ` Eli Zaretskii
2017-11-21 21:11 ` Kaushal Modi
2017-11-22 15:19 ` Eli Zaretskii
2017-11-22 15:58 ` Kaushal Modi
2017-11-22 16:20 ` Eli Zaretskii
2017-11-22 16:28 ` Kaushal Modi
2017-11-23 15:53 ` Eli Zaretskii
2017-11-23 17:34 ` Kaushal Modi
2017-11-23 20:08 ` Eli Zaretskii
2017-11-27 14:57 ` Kaushal Modi
2017-11-27 16:14 ` Eli Zaretskii [this message]
2017-11-27 17:04 ` Kaushal Modi
2017-11-27 17:27 ` Eli Zaretskii
2017-11-27 17:50 ` Kaushal Modi
2017-11-28 17:19 ` Eli Zaretskii
2017-11-28 17:34 ` Kaushal Modi
2017-11-28 17:51 ` Eli Zaretskii
2017-11-28 17:59 ` Kaushal Modi
2017-11-28 20:02 ` Davis Herring
2017-11-28 20:36 ` Eli Zaretskii
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=83r2sj66m6.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=emacs-devel@gnu.org \
--cc=kaushal.modi@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.