From f13ccbfa61fbf1982fb9fa0908d12aa18c4eaa75 Mon Sep 17 00:00:00 2001 From: Florian Neumann <983507+florianb@users.noreply.github.com> Date: Mon, 20 Jan 2025 13:00:23 +0100 Subject: [PATCH] Clarify capitalization of .editorconfig file see https://github.com/editorconfig/editorconfig/issues/523 --- index.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/index.rst b/index.rst index 4d3649b..ea19e89 100644 --- a/index.rst +++ b/index.rst @@ -51,9 +51,12 @@ Terminology In EditorConfig: -- "EditorConfig files" (usually named ``.editorconfig``) include section(s) - storing key-value pairs. EditorConfig files must conform to - this specification. +- "EditorConfig files" are files with the name `.editorconfig` that contain key-value pairs. + These files must follow this specification. + EditorConfig files may have been created on file systems that do not differentiate between + upper and lowercase letters. Therefore, plugins should recognise filenames that contain any + letter case, such as ".EditorConfig" or ".EDITORCONFIG". + It is recommended that the EditorConfig file be created in all lowercase. - "Cores" parse files conforming to this specification, and provide key-value pairs to plugins. - "Plugins" receive key-value pairs from cores and update an editor's