]> git.eshelyaron.com Git - emacs.git/commitdiff
Integrate feedback from Stefan Kangas and Michael Albinus
authorStefan Monnier <monnier@iro.umontreal.ca>
Wed, 19 Jun 2024 18:34:26 +0000 (14:34 -0400)
committerEshel Yaron <me@eshelyaron.com>
Fri, 21 Jun 2024 19:00:31 +0000 (21:00 +0200)
* lisp/editorconfig.el, lisp/editorconfig-tools.el, lisp/editorconfig-core.el:
* lisp/editorconfig-core-handle.el, lisp/editorconfig-conf-mode.el:
* lisp/editorconfig-fnmatch.el: Fix the reference to CONTRIBUTORS.
* doc/emacs/custom.texi (EditorConfig support):
* etc/NEWS: Improve wording and markup.

(cherry picked from commit 8d0a7c718b4e50056645ec1cab56423f5a31ce07)

doc/emacs/custom.texi
etc/NEWS
lisp/editorconfig-conf-mode.el
lisp/editorconfig-core-handle.el
lisp/editorconfig-core.el
lisp/editorconfig-fnmatch.el
lisp/editorconfig-tools.el
lisp/editorconfig.el

index c0ff573b13b850522d59f2f587989c0c40294df7..f5feb3db7e1951b01f686b0b6277fc3332e68be0 100644 (file)
@@ -1554,19 +1554,22 @@ as Dired buffers (@pxref{Dired}).
 @subsubsection Per-Directory Variables via EditorConfig
 @cindex EditorConfig support
 
-The EditorConfig standard is an alternative to the @code{.dir-locals.el}
+The EditorConfig standard is an alternative to the @file{.dir-locals.el}
 files, which can control only a very small number of variables, but
 has the advantage of being editor-neutral.  Those settings are stored in
-files named @code{.editorconfig}.
+files named @file{.editorconfig}.
 
 If you want Emacs to obey those settings, you need to enable
 the @code{editorconfig-mode} minor mode.  This is usually all that is
-needed: when the mode is activated, Emacs will look for @code{.editorconfig}
-files whenever a file is visited, just as it does for @code{.dir-locals.el}.
-
-When both @code{.editorconfig} and @code{.dir-locals.el} files are
-encountered, the corresponding settings are combined, and in case there
-is overlap, the settings coming from the nearest file take precedence.
+needed: when the mode is activated, Emacs will look for @file{.editorconfig}
+files whenever a file is visited, just as it does for @file{.dir-locals.el}.
+When both @file{.editorconfig} and @file{.dir-locals.el} files are
+found, their settings are combined, and in case of a conflict, the
+setting coming from the closest file takes precedence.
+If they are equally close, @file{.dir-locals.el} takes precedence.
+In terms of security, those settings are subject to the same checks
+as those coming from @file{.dir-locals.el} (and also honor
+@code{enable-local-variables}).
 
 The @code{indent_size} setting of the EditorConfig standard does not
 correspond to a fixed variable in Emacs, but instead needs to set
@@ -1577,7 +1580,7 @@ effect because the major mode does not yet support it, you can customize
 the @code{editorconfig-indentation-alist} variable to tell Emacs which
 variables need to be set in that major mode.
 
-Similarly, there are several different ways to ``trim whitespace'' at
+Similarly, there are several different ways to trim whitespace at
 the end of lines.  When the EditorConfig @code{trim_trailing_whitespace}
 setting is used, by default @code{editorconfig-mode} simply calls
 @code{delete-trailing-whitespace} every time you save your file.
index cfcf6923c9384ae8d6793a353e150c2ddd74c474..88e03202db8a7cec1339e944c0b0a2b5de2e3a57 100644 (file)
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -2058,11 +2058,11 @@ The following new XML schemas are now supported:
 * New Modes and Packages in Emacs 30.1
 
 ** New package EditorConfig.
-This package provides support for the EditorConfig standard that
-is an editor-neutral way to provide directory local settings.
+This package provides support for the EditorConfig standard,
+an editor-neutral way to provide directory local (project-wide) settings.
 It is enabled via a new global minor mode 'editorconfig-mode'
 which makes Emacs obey the '.editorconfig' files.
-And the package also comes with a new major mode 'editorconfig-conf-mode'
+There is also a new major mode 'editorconfig-conf-mode'
 to edit those configuration files.
 
 +++
index 105ce48a9bb39d4c8cbffbf8e2702b96b107fce9..3102c3d65817f2ba3b688de02c425908ced390c7 100644 (file)
@@ -5,8 +5,9 @@
 ;; Author: EditorConfig Team <editorconfig@googlegroups.com>
 
 ;; See
-;; https://github.com/editorconfig/editorconfig-emacs/graphs/contributors
-;; or the CONTRIBUTORS file for the list of contributors.
+;; https://github.com/editorconfig/editorconfig-emacs/graphs/contributors or
+;; https://github.com/editorconfig/editorconfig-emacs/blob/master/CONTRIBUTORS
+;; for the list of contributors.
 
 ;; This file is part of GNU Emacs.
 
index 8857c35c62c6f32f5747e0b61d830dc1c7b3ce1f..b8570ac5c6ae8ef26fed368e5e1089037f88f72e 100644 (file)
@@ -5,8 +5,9 @@
 ;; Author: EditorConfig Team <editorconfig@googlegroups.com>
 
 ;; See
-;; https://github.com/editorconfig/editorconfig-emacs/graphs/contributors
-;; or the CONTRIBUTORS file for the list of contributors.
+;; https://github.com/editorconfig/editorconfig-emacs/graphs/contributors or
+;; https://github.com/editorconfig/editorconfig-emacs/blob/master/CONTRIBUTORS
+;; for the list of contributors.
 
 ;; This file is part of GNU Emacs.
 
index 02a2b7885ec5765923bfd2ab1b0cd3c3f9e2718e..8183ff6298cd722980a40d268d71fcb2a968dfdb 100644 (file)
@@ -1,12 +1,13 @@
-;;; editorconfig-core.el --- EditorConfig Core library in Emacs Lisp  -*- lexical-binding: t -*-
+;;; editorconfig-core.el --- EditorConfig Core library  -*- lexical-binding: t -*-
 
 ;; Copyright (C) 2011-2024  Free Software Foundation, Inc.
 
 ;; Author: EditorConfig Team <editorconfig@googlegroups.com>
 
 ;; See
-;; https://github.com/editorconfig/editorconfig-emacs/graphs/contributors
-;; or the CONTRIBUTORS file for the list of contributors.
+;; https://github.com/editorconfig/editorconfig-emacs/graphs/contributors or
+;; https://github.com/editorconfig/editorconfig-emacs/blob/master/CONTRIBUTORS
+;; for the list of contributors.
 
 ;; This file is part of GNU Emacs.
 
index e614e8ef3e4fb02fd72db3a635f5c4fb8c8f4dfa..cd04088043477c5133973a3eb19fdc336793a383 100644 (file)
@@ -1,12 +1,13 @@
-;;; editorconfig-fnmatch.el --- Glob pattern matching in Emacs lisp  -*- lexical-binding: t -*-
+;;; editorconfig-fnmatch.el --- Glob pattern matching  -*- lexical-binding: t -*-
 
 ;; Copyright (C) 2011-2024  Free Software Foundation, Inc.
 
 ;; Author: EditorConfig Team <editorconfig@googlegroups.com>
 
 ;; See
-;; https://github.com/editorconfig/editorconfig-emacs/graphs/contributors
-;; or the CONTRIBUTORS file for the list of contributors.
+;; https://github.com/editorconfig/editorconfig-emacs/graphs/contributors or
+;; https://github.com/editorconfig/editorconfig-emacs/blob/master/CONTRIBUTORS
+;; for the list of contributors.
 
 ;; This file is part of GNU Emacs.
 
index ebc6a45d7bd21293229dd89140d8e0db9c057219..512dd67f56ff6e7c8bfeb57b4901afe8a40a4e93 100644 (file)
@@ -5,8 +5,9 @@
 ;; Author: EditorConfig Team <editorconfig@googlegroups.com>
 
 ;; See
-;; https://github.com/editorconfig/editorconfig-emacs/graphs/contributors
-;; or the CONTRIBUTORS file for the list of contributors.
+;; https://github.com/editorconfig/editorconfig-emacs/graphs/contributors or
+;; https://github.com/editorconfig/editorconfig-emacs/blob/master/CONTRIBUTORS
+;; for the list of contributors.
 
 ;; This file is part of GNU Emacs.
 
index 03b949ee71d67aa5c4199d8686827d41dca18585..46b5843f99fd052e2539e752aa22850ad585a53f 100644 (file)
@@ -9,8 +9,9 @@
 ;; Keywords: convenience editorconfig
 
 ;; See
-;; https://github.com/editorconfig/editorconfig-emacs/graphs/contributors
-;; or the CONTRIBUTORS file for the list of contributors.
+;; https://github.com/editorconfig/editorconfig-emacs/graphs/contributors or
+;; https://github.com/editorconfig/editorconfig-emacs/blob/master/CONTRIBUTORS
+;; for the list of contributors.
 
 ;; This file is part of GNU Emacs.