diff options
| author | Christian Duerr <contact@christianduerr.com> | 2023-06-12 02:23:41 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-06-12 00:23:41 +0000 |
| commit | bd4906722a1a026b01f06c94c33b13ff63a7e044 (patch) | |
| tree | a2713a7b0a5fa23ec8b9055d7ed06f1cede62447 /CONTRIBUTING.md | |
| parent | ea2c39e65d21728e0f04b0eafcec7153e4447cd5 (diff) | |
| download | alacritty-bd4906722a1a026b01f06c94c33b13ff63a7e044.tar.gz alacritty-bd4906722a1a026b01f06c94c33b13ff63a7e044.zip | |
Switch to TOML configuration format
This switches Alacritty's default configuration format from yaml to
toml. While yaml is still supported, it is done by converting it to toml
and should be removed entirely in the future.
All existing features were persisted based on my testing. Behavior
should not change much, though `--option` might have slightly different
behavior since the entire line is not interpreted as one line of toml.
A new `alacritty migrate` subcommand has been added which allows
automatic migration from yaml to toml. This also could be used as a
facility to automatically fix configuration file changes in the future.
Closes #6592.
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 3 |
1 files changed, 1 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e41b85f3..a40a81db 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -86,8 +86,7 @@ Latency is another important factor for Alacritty. On X11, Windows, and macOS th Code should be documented where appropriate. The existing code can be used as a guidance here and the general `rustfmt` rules can be followed for formatting. -If any change has been made to the `config.rs` file, these changes should also be documented in the -example configuration file `alacritty.yml`. +If any change has been made to the `config.rs` file, it should also be documented in the man pages. Changes compared to the latest Alacritty release which have a direct effect on the user (opposed to things like code refactorings or documentation/tests) additionally need to be documented in the |