andrei/niri
1
0
Fork 0
mirror of https://github.com/niri-wm/niri.git synced 2026-06-23 02:05:33 +07:00
Code Issues Packages Projects Releases 10 Wiki Activity

wiki: Update the wording on the configuration breaking change policy

Browse Source
This commit is contained in:
Ivan Molodetskikh
2025-03-01 09:45:57 +03:00
parent 88fcf0c2a9
commit 083a56c729
1 changed files with 2 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
wiki/Configuration:-Overview.md
+2 -5
View File
@@ -135,11 +135,8 @@ A notable exception is `binds {}`: they do not get filled with defaults, so make
### Breaking Change Policy ### Breaking Change Policy
Configuration backwards compatibility follows the Rust / Cargo semantic versioning standards. As a rule, niri updates should not break existing config files.
A patch release (i.e. niri 0.1.3 to 0.1.4) must not cause a parse error on a config that worked on the previous version. (For example, the default config from niri v0.1.0 still parses fine on v25.02 as I'm writing this.)
A minor release (i.e. niri 0.1.3 to 0.2.0) *can* cause previously valid config files to stop parsing.
When niri reaches 1.0, a major release (i.e. niri 1.0 to 2.0) will be required to break config backwards compatibility.
Exceptions can be made for parsing bugs. Exceptions can be made for parsing bugs.
For example, niri used to accept multiple binds to the same key, but this was not intended and did not do anything (the first bind was always used). For example, niri used to accept multiple binds to the same key, but this was not intended and did not do anything (the first bind was always used).