From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Kaushal Modi Newsgroups: gmane.emacs.devel Subject: Re: Relics of removed dir-locals-file-2 feature in pretest Date: Mon, 27 Nov 2017 17:50:33 +0000 Message-ID: References: <833757cqy7.fsf@gnu.org> <83tvxmbat5.fsf@gnu.org> <83lgiyb801.fsf@gnu.org> <83d149at4o.fsf@gnu.org> <831skobvvw.fsf@gnu.org> <83r2sj66m6.fsf@gnu.org> <83h8tf638h.fsf@gnu.org> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="001a11416c4c99437b055efa8a75" X-Trace: blaine.gmane.org 1511805065 4498 195.159.176.226 (27 Nov 2017 17:51:05 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Mon, 27 Nov 2017 17:51:05 +0000 (UTC) Cc: emacs-devel@gnu.org To: Eli Zaretskii Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Mon Nov 27 18:51:00 2017 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1eJNYR-0000Ds-JO for ged-emacs-devel@m.gmane.org; Mon, 27 Nov 2017 18:50:51 +0100 Original-Received: from localhost ([::1]:34019 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eJNYZ-0005Ig-0B for ged-emacs-devel@m.gmane.org; Mon, 27 Nov 2017 12:50:59 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:55013) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eJNYN-0005Gx-Uy for emacs-devel@gnu.org; Mon, 27 Nov 2017 12:50:49 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1eJNYM-0000LZ-PJ for emacs-devel@gnu.org; Mon, 27 Nov 2017 12:50:48 -0500 Original-Received: from mail-yb0-x233.google.com ([2607:f8b0:4002:c09::233]:33521) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1eJNYK-0000Kv-QU; Mon, 27 Nov 2017 12:50:44 -0500 Original-Received: by mail-yb0-x233.google.com with SMTP id y14so10900973ybi.0; Mon, 27 Nov 2017 09:50:44 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc; bh=zqWBPTx0Cc3clIhwpn4hyiYHcagfUcNNbxJDI/BTxJM=; b=SiLSie/05aQUQn1akji6pcSob5R12XiEU1yP/lJBGMzlYpUlJ8jRMUceXn1sd/FPm+ qbRsWVSeh4mkSXkYbXgeWgyQdRk2PXjR9buNF+jMIL3quC4P/BxdoaTA/g9GH/IebQs8 A9zNi0maAA0ZMJTnstsk0CLHgY9MEHzMtv4JBDu6K9eMrmRAQayoULGiUUlGJxXTmpbA 12ezShccaoLLHRsyeGgNMBGrCJ78VfEE/iVpVfQKFbNxP2pRSVrcqtfNGkSSkLaYwgxY EV2sM6+5167UKCSOW72crlrwWD+bnfq4/2Yrodll9JnS4PVnaGLXzjG7ZyIZpvgt7BgT pGxg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=zqWBPTx0Cc3clIhwpn4hyiYHcagfUcNNbxJDI/BTxJM=; b=iQsubG0mU0K4ok/5xmG1AJPd82rd9JqGOwJJdrJrNPQbJ1FGQzxfTzPrqzLiVVRbU6 8vnvQE8PfUD+iboRplKldXlEGaLXRvitAQOaur44rC1aHicJt6PkMPj4aXG9YOEs211O abE+gQEzUJQQQd7bfLczJ1nCbqjFd1fFi6xytt2KH4u2CHzv116koQs94RmzkRDEXl8q zvK8rRAqcAjszqs+cPs9feaVe1bK7qU4ofGBnO+EZ8aVv2xko6N7jjMCWttlsG8CnG5e G7c4tb3i7zXQW39E98UXS5yLypc7MSzBi3iaayzwG9sIyc8SqJO7hfiNrTFt48ldlFus DNFw== X-Gm-Message-State: AJaThX6aADflULo0dYE11cbyhcSgAv4C0UUzVaQenPVdcbDZRcZHlmZH 8ATJ0eHHAZNm/TMoEdBID4n0CSMH3AsmLYa4nzA= X-Google-Smtp-Source: AGs4zMZyC55aFa/bV86fD8HmLmCf3yKbESgzDrXckddwkkY7ceyI49J+y6trt5aNHyXz0drSg8CH6BAzt/PwjTHAAAY= X-Received: by 10.37.22.85 with SMTP id 82mr23586775ybw.493.1511805043669; Mon, 27 Nov 2017 09:50:43 -0800 (PST) In-Reply-To: <83h8tf638h.fsf@gnu.org> X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2607:f8b0:4002:c09::233 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.org gmane.emacs.devel:220490 Archived-At: --001a11416c4c99437b055efa8a75 Content-Type: multipart/alternative; boundary="001a11416c4c994376055efa8a73" --001a11416c4c994376055efa8a73 Content-Type: text/plain; charset="UTF-8" Thanks for the quick feedback. My comments are inline below, followed by updated patch. On Mon, Nov 27, 2017 at 12:28 PM Eli Zaretskii wrote: > > * lisp/files.el: Remove unused constant `dir-locals-file-2'. > > This should be formatted as follows: > > * lisp/files.el (dir-locals-file-2): Remove unused constant. > Now fixed (I wasn't quite sure if I should do * foo (bar): if bar was being removed). > * lisp/files.el(dir-locals-file): > ^^ > Missing space. > Fixed. > * doc/lispref/variables.texi (Directory Local Variables): Mention > > ".dir-locals-2.el". > > These two don't really live together well: one is code, the other > documentation. So the first one is better written as a separate > entry: > > * lisp/files.el (dir-locals-file): Mention '.dir-locals-2.el' in the > doc string. > Fixed. Will keep the point in mind about keeping code and doc separate. > doc/lispref/variables.texi | 29 +++++++++++++++++------------ > > etc/NEWS | 2 +- > > lisp/files.el | 18 +++++++++--------- > > 3 files changed, 27 insertions(+), 22 deletions(-) > > The change in NEWS should also be mentioned in the log message. > Done. This looks like a lot of changes, but it actually only changes the > last few lines. Please try not to refill existing text you don't > modify (unless it's really badly formatted), so that the actual > changes are clearly visible. > Understood. I thought that doing M-q was the right thing to do. I have now manually filled only the edited lines. > + This second file name is > > +derived by appending \"-2\" to the file name component without > > +extension in `dir-locals-file'. > > This sentence is slightly confusing. Suggest to reword: > > The name of this second file is derived by appending \"-2\" to > the base name of `dir-locals-file'. > > > + For example, if the value of > > +`dir-locals-file' is \".dir-locals.el\", a \".dir-locals-2.el\" > > +file in the same directory will override the \".dir-locals.el\". > > And this sentence could be made simpler if you just describe the > default case: > > With the default value of `dir-locals-file', a \".dir-locals-2.el\" > file in the same directory will override \".dir-locals.el\". > Done. Updated patch is attached. Thank you. -- Kaushal Modi --001a11416c4c994376055efa8a73 Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable
Thanks for the quick feedb= ack. My comments are inline below, followed by updated patch.
On Mon, Nov 27, 2017 at 12:28 PM Eli Zaretskii <= eliz@gnu.org> wrote:
> * lisp/files.el: Remove unused constant `dir-= locals-file-2'.

This should be formatted as follows:

=C2=A0* lisp/files.el (dir-locals-file-2): Remove unused constant.

Now fixed (I wasn't quite sure if I should = do * foo (bar): if bar was being removed).

> * lisp/files.el(dir-locals-file):
=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 ^^
Missing space.

Fixed.

> * doc/lispref/variables.texi (Directory Local Variables): Mention
>=C2=A0 =C2=A0".dir-locals-2.el".

These two don't really live together well: one is code, the other
documentation.=C2=A0 So the first one is better written as a separate
entry:

=C2=A0* lisp/files.el (dir-locals-file): Mention '.dir-locals-2.el'= in the
=C2=A0 =C2=A0doc string.

Fixed. Will ke= ep the point in mind about keeping code and doc separate.

>=C2=A0 doc/lispref/variables.texi | 29 +++++++++++++++++------------ >=C2=A0 etc/NEWS=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 = =C2=A0 =C2=A0|=C2=A0 2 +-
>=C2=A0 lisp/files.el=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 | = 18 +++++++++---------
>=C2=A0 3 files changed, 27 insertions(+), 22 deletions(-)

The change in NEWS should also be mentioned in the log message.

Done.

This looks like a lot of changes, but it actually only changes the
last few lines.=C2=A0 Please try not to refill existing text you don't<= br> modify (unless it's really badly formatted), so that the actual
changes are clearly visible.

Understood= . I thought that doing M-q was the right thing to do. I have now manually f= illed only the edited lines.

> +=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0= =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 This second= file name is
> +derived by appending \"-2\" to the file name component with= out
> +extension in `dir-locals-file'.

This sentence is slightly confusing.=C2=A0 Suggest to reword:

=C2=A0 The name of this second file is derived by appending \"-2\"= ; to
=C2=A0 the base name of `dir-locals-file'.

> +=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0= =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0For example, if the value = of
> +`dir-locals-file' is \".dir-locals.el\", a \".dir-= locals-2.el\"
> +file in the same directory will override the \".dir-locals.el\&q= uot;.

And this sentence could be made simpler if you just describe the
default case:

=C2=A0 With the default value of `dir-locals-file', a \".dir-local= s-2.el\"
=C2=A0 file in the same directory will override \".dir-locals.el\"= ;.

Done.

Updat= ed patch is attached. Thank you.
-- <= br>
=

Kaushal Modi

--001a11416c4c994376055efa8a73-- --001a11416c4c99437b055efa8a75 Content-Type: application/octet-stream; name="0001-Update-documentation-about-.dir-locals-2.el.patch" Content-Disposition: attachment; filename="0001-Update-documentation-about-.dir-locals-2.el.patch" Content-Transfer-Encoding: base64 Content-ID: <15ffe98bdb0ae12b5f1> X-Attachment-Id: 15ffe98bdb0ae12b5f1 RnJvbSA5NjY3MTQ5YzcyYmEyNzYyOTNhMjQxMmMzZDU2ZmU1MjJiN2E3MDE5IE1vbiBTZXAgMTcg MDA6MDA6MDAgMjAwMQpGcm9tOiBLYXVzaGFsIE1vZGkgPGthdXNoYWwubW9kaUBnbWFpbC5jb20+ CkRhdGU6IE1vbiwgMjcgTm92IDIwMTcgMTE6NDY6NTQgLTA1MDAKU3ViamVjdDogW1BBVENIXSBV cGRhdGUgZG9jdW1lbnRhdGlvbiBhYm91dCAuZGlyLWxvY2Fscy0yLmVsCgoqIGxpc3AvZmlsZXMu ZWwgKGRpci1sb2NhbHMtZmlsZS0yKTogUmVtb3ZlIHVudXNlZCBjb25zdGFudC4KKiBsaXNwL2Zp bGVzLmVsIChkaXItbG9jYWxzLWZpbGUpOiBNZW50aW9uICIuZGlyLWxvY2Fscy0yLmVsIiBpbiB0 aGUKICBkb2Mgc3RyaW5nLgoqIGRvYy9saXNwcmVmL3ZhcmlhYmxlcy50ZXhpIChEaXJlY3Rvcnkg TG9jYWwgVmFyaWFibGVzKTogTWVudGlvbgogICIuZGlyLWxvY2Fscy0yLmVsIi4KKiBldGMvTkVX UzogUmVwbGFjZSBgZGlyLWxvY2Fscy1maWxlLTInIG1lbnRpb24gd2l0aAogIGBkaXItbG9jYWxz LWZpbGUnLgoKKGh0dHBzOi8vbGlzdHMuZ251Lm9yZy9yL2VtYWNzLWRldmVsLzIwMTctMTEvbXNn MDA2NDkuaHRtbCkKLS0tCiBkb2MvbGlzcHJlZi92YXJpYWJsZXMudGV4aSB8ICA3ICsrKysrKy0K IGV0Yy9ORVdTICAgICAgICAgICAgICAgICAgIHwgIDIgKy0KIGxpc3AvZmlsZXMuZWwgICAgICAg ICAgICAgIHwgMTggKysrKysrKysrLS0tLS0tLS0tCiAzIGZpbGVzIGNoYW5nZWQsIDE2IGluc2Vy dGlvbnMoKyksIDExIGRlbGV0aW9ucygtKQoKZGlmZiAtLWdpdCBhL2RvYy9saXNwcmVmL3Zhcmlh Ymxlcy50ZXhpIGIvZG9jL2xpc3ByZWYvdmFyaWFibGVzLnRleGkKaW5kZXggYTg3MTM1MmIwMC4u NWJlZTBmOWQ4MiAxMDA2NDQKLS0tIGEvZG9jL2xpc3ByZWYvdmFyaWFibGVzLnRleGkKKysrIGIv ZG9jL2xpc3ByZWYvdmFyaWFibGVzLnRleGkKQEAgLTE5MTksNyArMTkxOSwxMiBAQCBEaXJlY3Rv cnkgTG9jYWwgVmFyaWFibGVzCiAob3B0aW9uYWxseSwgeW91IGNhbiBleGNsdWRlIHN1YmRpcmVj dG9yaWVzOyBzZWUgYmVsb3cpLgogSWYgc29tZSBvZiB0aGUgc3ViZGlyZWN0b3JpZXMgaGF2ZSB0 aGVpciBvd24gQGZpbGV7LmRpci1sb2NhbHMuZWx9CiBmaWxlcywgRW1hY3MgdXNlcyB0aGUgc2V0 dGluZ3MgZnJvbSB0aGUgZGVlcGVzdCBmaWxlIGl0IGZpbmRzIHN0YXJ0aW5nCi1mcm9tIHRoZSBm aWxlJ3MgZGlyZWN0b3J5IGFuZCBtb3ZpbmcgdXAgdGhlIGRpcmVjdG9yeSB0cmVlLiAgVGhlIGZp bGUKK2Zyb20gdGhlIGZpbGUncyBkaXJlY3RvcnkgYW5kIG1vdmluZyB1cCB0aGUgZGlyZWN0b3J5 IHRyZWUuICBUaGlzCitjb25zdGFudCBpcyBhbHNvIHVzZWQgdG8gZGVyaXZlIHRoZSBuYW1lIG9m IGEgc2Vjb25kIGRpci1sb2NhbHMgZmlsZQorQGZpbGV7LmRpci1sb2NhbHMtMi5lbH0uICBJZiB0 aGlzIHNlY29uZCBkaXItbG9jYWxzIGZpbGUgaXMgcHJlc2VudCwKK3RoZW4gdGhhdCBpcyBsb2Fk ZWQgaW5zdGVhZCBvZiBAZmlsZXsuZGlyLWxvY2Fscy5lbH0uICBUaGlzIGlzIHVzZWZ1bAord2hl biBAZmlsZXsuZGlyLWxvY2Fscy5lbH0gaXMgdW5kZXIgdmVyc2lvbiBjb250cm9sIGluIGEgc2hh cmVkCityZXBvc2l0b3J5IGFuZCBjYW5ub3QgYmUgdXNlZCBmb3IgcGVyc29uYWwgY3VzdG9taXph dGlvbnMuICBUaGUgZmlsZQogc3BlY2lmaWVzIGxvY2FsIHZhcmlhYmxlcyBhcyBhIHNwZWNpYWxs eSBmb3JtYXR0ZWQgbGlzdDsgc2VlCiBAcmVme0RpcmVjdG9yeSBWYXJpYWJsZXMsICwgUGVyLWRp cmVjdG9yeSBMb2NhbCBWYXJpYWJsZXMsIGVtYWNzLCBUaGUKIEdOVSBFbWFjcyBNYW51YWx9LCBm b3IgbW9yZSBkZXRhaWxzLgpkaWZmIC0tZ2l0IGEvZXRjL05FV1MgYi9ldGMvTkVXUwppbmRleCBm N2E5ZmViNmU0Li40Y2NmNDY4NjkzIDEwMDY0NAotLS0gYS9ldGMvTkVXUworKysgYi9ldGMvTkVX UwpAQCAtMzY2LDcgKzM2Niw3IEBAIFRoZXNlIGxvY2FsIHZhcmlhYmxlcyB3aWxsIHRodXMgbm90 IHZhbmlzaCBvbiBzZXR0aW5nIGEgbWFqb3IgbW9kZS4KIAogKysrCiAqKiBBIHNlY29uZCBkaXIt bG9jYWwgZmlsZSAoLmRpci1sb2NhbHMtMi5lbCkgaXMgbm93IGFjY2VwdGVkLgotU2VlIHRoZSB2 YXJpYWJsZSAnZGlyLWxvY2Fscy1maWxlLTInIGZvciBtb3JlIGluZm9ybWF0aW9uLgorU2VlIHRo ZSBkb2Mgc3RyaW5nIG9mICdkaXItbG9jYWxzLWZpbGUnIGZvciBtb3JlIGluZm9ybWF0aW9uLgog CiArKysKICoqIENvbm5lY3Rpb24tbG9jYWwgdmFyaWFibGVzIGNhbiBiZSB1c2VkIHRvIHNwZWNp ZnkgbG9jYWwgdmFyaWFibGVzCmRpZmYgLS1naXQgYS9saXNwL2ZpbGVzLmVsIGIvbGlzcC9maWxl cy5lbAppbmRleCBkOGIzOGE5ZjE2Li44MDIxZTFiYmVkIDEwMDY0NAotLS0gYS9saXNwL2ZpbGVz LmVsCisrKyBiL2xpc3AvZmlsZXMuZWwKQEAgLTM5MDUsMTYgKzM5MDUsMTYgQEAgZGlyLWxvY2Fs cy1maWxlCiAgICJGaWxlIHRoYXQgY29udGFpbnMgZGlyZWN0b3J5LWxvY2FsIHZhcmlhYmxlcy4K IEl0IGhhcyB0byBiZSBjb25zdGFudCB0byBlbmZvcmNlIHVuaWZvcm0gdmFsdWVzIGFjcm9zcyBk aWZmZXJlbnQKIGVudmlyb25tZW50cyBhbmQgdXNlcnMuCi1TZWUgYWxzbyBgZGlyLWxvY2Fscy1m aWxlLTInLCB3aG9zZSB2YWx1ZXMgb3ZlcnJpZGUgdGhpcyBvbmUncy4KLVNlZSBJbmZvIG5vZGUg YChlbGlzcClEaXJlY3RvcnkgTG9jYWwgVmFyaWFibGVzJyBmb3IgZGV0YWlscy4iKQogCi0oZGVm Y29uc3QgZGlyLWxvY2Fscy1maWxlLTIgIi5kaXItbG9jYWxzLTIuZWwiCi0gICJGaWxlIHRoYXQg Y29udGFpbnMgZGlyZWN0b3J5LWxvY2FsIHZhcmlhYmxlcy4KLVRoaXMgZXNzZW50aWFsbHkgYSBz ZWNvbmQgZmlsZSB0aGF0IGNhbiBiZSB1c2VkIGxpa2UKLWBkaXItbG9jYWxzLWZpbGUnLCBzbyB0 aGF0IHVzZXJzIGNhbiBoYXZlIHNwZWNpZnkgdGhlaXIgcGVyc29uYWwKLWRpci1sb2NhbCB2YXJp YWJsZXMgZXZlbiBpZiB0aGUgY3VycmVudCBkaXJlY3RvcnkgYWxyZWFkeSBoYXMgYQotYGRpci1s b2NhbHMtZmlsZScgdGhhdCBpcyBzaGFyZWQgd2l0aCBvdGhlciB1c2VycyAoc3VjaCBhcyBpbiBh Ci1naXQgcmVwb3NpdG9yeSkuCitBIHNlY29uZCBkaXItbG9jYWxzIGZpbGUgY2FuIGJlIHVzZWQg YnkgYSB1c2VyIHRvIHNwZWNpZnkgdGhlaXIKK3BlcnNvbmFsIGRpci1sb2NhbCB2YXJpYWJsZXMg ZXZlbiBpZiB0aGUgY3VycmVudCBkaXJlY3RvcnkKK2FscmVhZHkgaGFzIGEgYGRpci1sb2NhbHMt ZmlsZScgdGhhdCBpcyBzaGFyZWQgd2l0aCBvdGhlcgordXNlcnMgKHN1Y2ggYXMgaW4gYSBnaXQg cmVwb3NpdG9yeSkuICBUaGUgbmFtZSBvZiB0aGlzIHNlY29uZAorZmlsZSBpcyBkZXJpdmVkIGJ5 IGFwcGVuZGluZyBcIi0yXCIgdG8gdGhlIGJhc2UgbmFtZSBvZgorYGRpci1sb2NhbHMtZmlsZScu ICBXaXRoIHRoZSBkZWZhdWx0IHZhbHVlIG9mIGBkaXItbG9jYWxzLWZpbGUnLAorYSBcIi5kaXIt bG9jYWxzLTIuZWxcIiBmaWxlIGluIHRoZSBzYW1lIGRpcmVjdG9yeSB3aWxsIG92ZXJyaWRlCit0 aGUgXCIuZGlyLWxvY2Fscy5lbFwiLgorCiBTZWUgSW5mbyBub2RlIGAoZWxpc3ApRGlyZWN0b3J5 IExvY2FsIFZhcmlhYmxlcycgZm9yIGRldGFpbHMuIikKIAogKGRlZnVuIGRpci1sb2NhbHMtLWFs bC1maWxlcyAoZGlyZWN0b3J5KQotLSAKMi4xNS4wCgo= --001a11416c4c99437b055efa8a75--