Unify changelog section order
This clarifies the order of subsections in the changelog. All entries are now defined in the order `Packaging`, `Removed`, `Added`, `Changed` and `Fixed`. The sections `Security` and `Deprecated` have been removed. Since deprecation should always just be a soft deprecation with clear user warnings, it's not much different from just `Changed`, so that should make it easier to decide where to put things. The `Security` section is often not clear enough since a lot of changes might have some form of security impact depending on interpretation. Since there's unlikely to be any major security advisories from the Alacritty project, that section is not particularly useful. The `Added`, `Changed` and `Fixed` order follows the interest of the user and the impact on them. This puts the most interesting new features front and center while allowing to go for a deep dive to see if specific bugs have been fixed. The `Removed` section was put last since realistically this should not affect users. All options should be gradually deprecated and no major features should just get removed. So most of the time this will just list deprecated features that are now completely removed, which usually means there's no impact for users that updated from the last version.
This commit is contained in:
Christian Duerr
parent
6378830469
commit
a2b7c9544b
63
CHANGELOG.md
63
CHANGELOG.md
|
|
@ -1,8 +1,9 @@
|
|||
# Changelog
|
||||
All notable changes to this project will be documented in this file.
|
||||
|
||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
All notable changes to Alacritty are documented in this file.
|
||||
The sections should follow the order `Packaging`, `Added`, `Changed`, `Fixed` and `Removed`.
|
||||
|
||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
|
||||
|
||||
## 0.6.0-dev
|
||||
|
||||
|
|
@ -28,13 +29,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||
- Added manpage, terminfo, and completions to macOS application bundle
|
||||
- On Linux/BSD the build will fail without Fontconfig installed, instead of building it from source
|
||||
|
||||
### Removed
|
||||
|
||||
- Environment variable `RUST_LOG` for selecting the log level
|
||||
- Deprecated `window.start_maximized` config field
|
||||
- Deprecated `render_timer` config field
|
||||
- Deprecated `persistent_logging` config field
|
||||
|
||||
### Added
|
||||
|
||||
- Default Command+N keybinding for SpawnNewInstance on macOS
|
||||
|
|
@ -92,6 +86,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||
- Alacritty crashing at startup when the configured font does not exist
|
||||
- Font size rounding error
|
||||
|
||||
### Removed
|
||||
|
||||
- Environment variable `RUST_LOG` for selecting the log level
|
||||
- Deprecated `window.start_maximized` config field
|
||||
- Deprecated `render_timer` config field
|
||||
- Deprecated `persistent_logging` config field
|
||||
|
||||
## 0.4.3
|
||||
|
||||
### Fixed
|
||||
|
|
@ -521,10 +522,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||
|
||||
- All options in the configuration file are now optional
|
||||
|
||||
### Removed
|
||||
|
||||
- Windows and macOS configuration files (`alacritty.yml` is now platform independent)
|
||||
|
||||
### Fixed
|
||||
|
||||
- Replaced `Command` with `Super` in the Linux and Windows config documentation
|
||||
|
|
@ -534,6 +531,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||
- Characters will no longer be deleted when using ncurses with the hard tab optimization
|
||||
- Crash on non-linux operating systems when using the `SpawnNewInstance` action
|
||||
|
||||
### Removed
|
||||
|
||||
- Windows and macOS configuration files (`alacritty.yml` is now platform independent)
|
||||
|
||||
## Version 0.2.5
|
||||
|
||||
### Added
|
||||
|
|
@ -621,13 +622,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||
- Extra padding is now spread evenly around the terminal grid
|
||||
- DEB file installs to `usr/bin` instead of `usr/local/bin`
|
||||
|
||||
### Removed
|
||||
|
||||
- The `custom_cursor_colors` config field was deleted, remove the `colors.cursor.*` options
|
||||
to achieve the same behavior as setting it to `false`
|
||||
- The `scale_with_dpi` configuration value has been removed, on Linux the env
|
||||
variable `WINIT_HIDPI_FACTOR=1` can be set instead to disable DPI scaling
|
||||
|
||||
### Fixed
|
||||
|
||||
- Fixed erroneous results when using the `indexed_colors` config option
|
||||
|
|
@ -646,6 +640,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||
- On macOS, Alacritty will now use the integrated GPU again when available
|
||||
- On Linux, the `WINIT_HIDPI_FACTOR` environment variable can be set from the config now
|
||||
|
||||
### Removed
|
||||
|
||||
- The `custom_cursor_colors` config field was deleted, remove the `colors.cursor.*` options
|
||||
to achieve the same behavior as setting it to `false`
|
||||
- The `scale_with_dpi` configuration value has been removed, on Linux the env
|
||||
variable `WINIT_HIDPI_FACTOR=1` can be set instead to disable DPI scaling
|
||||
|
||||
## Version 0.2.1
|
||||
|
||||
### Added
|
||||
|
|
@ -671,11 +672,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||
present on the system
|
||||
- The default `TERM` value is no longer static; the `alacritty` entry is used if
|
||||
available, otherwise the `xterm-256color` entry is used instead
|
||||
|
||||
### Removed
|
||||
|
||||
- The terminfo entry `alacritty-256color`. It is replaced by the `alacritty`
|
||||
entry (which also advertises 256 colors)
|
||||
- The values `true` and `false` for the config option `window.decorations` have been replaced with
|
||||
`full` and `none`
|
||||
|
||||
### Fixed
|
||||
|
||||
|
|
@ -686,16 +684,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||
- Empty lines in selections are now properly copied to the clipboard
|
||||
- Selection start point lagging behind initial cursor position
|
||||
- Rendering of selections which start above the visible area and end below it
|
||||
|
||||
### Deprecated
|
||||
|
||||
- The config option `window.decorations` should now use `full` or `none` instead
|
||||
of `true` or `false`, respectively.
|
||||
|
||||
### Security
|
||||
|
||||
- Bracketed paste mode now filters escape sequences beginning with \x1b
|
||||
|
||||
### Removed
|
||||
|
||||
- The terminfo entry `alacritty-256color`. It is replaced by the `alacritty`
|
||||
entry (which also advertises 256 colors)
|
||||
|
||||
## Version 0.2.0
|
||||
|
||||
### Added
|
||||
|
|
|
|||
Loading…
Reference in New Issue