diff --git a/conf.py b/conf.py index 4ca4da9..04b29d7 100644 --- a/conf.py +++ b/conf.py @@ -21,8 +21,8 @@ copyright = '2019--2024, EditorConfig Team' author = 'EditorConfig Team' -version = '0.16.1' -release = '0.16.1' +version = '0.17.1' +release = '0.17.1' # -- General configuration --------------------------------------------------- diff --git a/index.rst b/index.rst index 9abf5fa..cc44432 100644 --- a/index.rst +++ b/index.rst @@ -73,6 +73,8 @@ EditorConfig organization. File Format =========== +.. versionchanged:: 0.17.0 + EditorConfig files are in an INI-like file format. In an EditorConfig file, all beginning whitespace on each line is considered irrelevant. Each line must be one of the following: @@ -94,7 +96,7 @@ irrelevant. Each line must be one of the following: Any line that is not one of the above is invalid. -EditorConfig files should be UTF-8 encoded, with LF or CRLF line separators. +EditorConfig files must be UTF-8 encoded, with LF or CRLF line separators. No inline comments ------------------ @@ -160,6 +162,13 @@ special characters for wildcard matching: - any integer numbers between ``num1`` and ``num2``, where ``num1`` and ``num2`` can be either positive or negative +If the glob contains a path separator (a ``/`` not inside square brackets), then the glob is relative +to the directory level of the particular `.editorconfig` file itself. +Otherwise the pattern may also match at any level below the `.editorconfig` +level. For example, ``*.c`` matches any file that ends with ``.c`` in the +directory of ``.editorconfig``, but ``subdir/*.c`` only matches files that end +with ``.c`` in the ``subdir`` directory in the directory of ``.editorconfig``. + The backslash character (``\\``) can be used to escape a character so it is not interpreted as a special character.