Rooba
/
polybar
mirror of https://github.com/polybar/polybar.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity
polybar/CHANGELOG.md

119 lines
6.1 KiB
Markdown
Raw Normal View History

Adopt "keep a changelog" (#2308) * Adopt keep a changelog Ref: https://keepachangelog.com/en/1.0.0/ * Add changelog to release and contributing docs * Use H2 for automatically added Download section The individual changelog subsections use H3 and the changelog section uses H2, so the Download section should use the same heading * Add already present changes to changelog * Mention changelog issue references in CONTRIBUTING.md
2020-12-16 15:04:10 +00:00
# Changelog
All notable changes to this project will be documented in this file.
Each release should have the following subsections, if entries exist, in the
given order: `Breaking`, `Build`, `Deprecated`, `Removed`, `Added`, `Changed`,
`Fixed`, `Security`.
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).
## [Unreleased]
New Tag Parser (#2303) * refactor(color): Use enum class for color type * Add testcases for tag parser * Make tag parser a pull-style parser Being able to parse single elements at a time gives us more fine-grained error messages, we can also parse as much as possible and only stop after an exception. * fix(color): Parser did not check for invalid chars * tag parser: First full implementation * tag parser: Fix remaining failing tests * tag parser: Replace old parser * tag parser: Treat alignment as formatting tag Makes the structure less complex and the alignment tags really are formatting tags, they are structurally no different from the %{R} tag. * tag parser: Cleanup type definitions All type definitions for tags now live in tags/types.hpp, the parser.hpp only contains the definitions necessary for actually calling the parser, this shouldn't be included in many places (only places that actually do parsing). But many places need the definitions for the tags themselves. * Rename components/parser to tags/dispatch * tag parser: Cleanup * Add changelog
2020-12-17 19:37:28 +00:00
### Breaking
Add initial support for an escape character (#2361) Add a config parser method which, for now, deals only with escaping the literal backslash character and logs an error message to inform the user of the coming change. The error message includes a properly escaped value for the user. As a result of introducing an escape character('\'): - Warn the user of any unescaped backslashes, as they will not be treated as a literal character in the future - For now, still treat a single backslash as a literal character - Treat two consecutive backslashes as a single properly escaped literal backslash Also: - Add documentation about the escape character to polybar(5) manpage - Add info about the escape character to changelog - Add testcases for ParseLineKeyTest - Add new test ParseEscapedValueTest Resolves: First step in #2354 Improve value parsing - Take value arg in as an rvalue reference and move parsed value back - Remove unnecessary if statement - Rename function - Improve error message - Improve function description - Format Add escape character documentation to manpages Add information about the escape character to the polybar(5) manpage. Add info about the esacape character to changelog Add test cases for ParseLineKeyTest Fix ParseLineKeyTest test cases Also make config parser method parse_escaped_value private. Add tests for escaped_value_parser method Also remove unsued include statement Simplify parse_escaped_value in config_parser Remove unnecessary escaped value generation, so we do not have to keep track of index differences. Fix ParseEscapedValueTest test cases Fix parse_escaped_value Add more test cases for ParseLineKeyTest Update CHANGELOG.md Co-authored-by: Patrick Ziegler <p.ziegler96@gmail.com> Adress review - Adjust documentation - Small code changes Improve parse_escaped_value Add initial support for an escape character Add a config parser method which, for now, deals only with escaping the literal backslash character and logs an error message to inform the user of the coming change. The error message includes a properly escaped value for the user. As a result of introducing an escape character('\'): - Warn the user of any unescaped backslashes, as they will not be treated as a literal character in the future - For now, still treat a single backslash as a literal character - Treat two consecutive backslashes as a single properly escaped literal backslash Resolves: First step in #2354 Improve value parsing - Take value arg in as an rvalue reference and move parsed value back - Remove unnecessary if statement - Rename function - Improve error message - Improve function description - Format Add info about the esacape character to changelog Add test cases for ParseLineKeyTest Fix ParseLineKeyTest test cases Also make config parser method parse_escaped_value private. Add tests for escaped_value_parser method Also remove unsued include statement Simplify parse_escaped_value in config_parser Remove unnecessary escaped value generation, so we do not have to keep track of index differences. Fix ParseEscapedValueTest test cases Add more test cases for ParseLineKeyTest Adress review - Adjust documentation - Small code changes Remove duplicate testcase from ParseLineKeyTest Add initial support for an escape character Add a config parser method which, for now, deals only with escaping the literal backslash character and logs an error message to inform the user of the coming change. The error message includes a properly escaped value for the user. As a result of introducing an escape character('\'): - Warn the user of any unescaped backslashes, as they will not be treated as a literal character in the future - For now, still treat a single backslash as a literal character - Treat two consecutive backslashes as a single properly escaped literal backslash Resolves: First step in #2354 Improve value parsing - Take value arg in as an rvalue reference and move parsed value back - Remove unnecessary if statement - Rename function - Improve error message - Improve function description - Format Fix ParseLineKeyTest test cases Also make config parser method parse_escaped_value private. Remove duplicate testcase from ParseLineKeyTest
2021-01-26 18:16:29 +00:00
- We added the backslash escape character (\\) for configuration values. This
means that the literal backslash character now has special meaning in
configuration files, therefore if you want to use it in a value as a literal
backslash, you need to escape it with the backslash escape character. The
parser logs an error if any unescaped backslashes are found in a value. This
affects you only if you are using two consecutive backslashes in a value,
which will now be interpreted as a single literal backslash.
[`#2354`](https://github.com/polybar/polybar/issues/2354)
New Tag Parser (#2303) * refactor(color): Use enum class for color type * Add testcases for tag parser * Make tag parser a pull-style parser Being able to parse single elements at a time gives us more fine-grained error messages, we can also parse as much as possible and only stop after an exception. * fix(color): Parser did not check for invalid chars * tag parser: First full implementation * tag parser: Fix remaining failing tests * tag parser: Replace old parser * tag parser: Treat alignment as formatting tag Makes the structure less complex and the alignment tags really are formatting tags, they are structurally no different from the %{R} tag. * tag parser: Cleanup type definitions All type definitions for tags now live in tags/types.hpp, the parser.hpp only contains the definitions necessary for actually calling the parser, this shouldn't be included in many places (only places that actually do parsing). But many places need the definitions for the tags themselves. * Rename components/parser to tags/dispatch * tag parser: Cleanup * Add changelog
2020-12-17 19:37:28 +00:00
- We rewrote our tag parser. This shouldn't break anything, if you experience
any problems, please let us know.
The new parser now gives errors for certain invalid tags where the old parser
would just silently ignore them. Adding extra text to the end of a valid tag
now produces an error. For example, tags like `%{T-a}`, `%{T2abc}`, `%{rfoo}`,
and others will now start producing errors.
This does not affect you unless you are producing your own formatting tags
(for example in a script) and you are using one of these invalid tags.
build: Bump cmake version to 3.5.0 This includes the changes from polybar/xpp#30 which also updates the minimum cmake version in the xpp submodule
2020-12-22 00:58:21 +00:00
### Build
- Bump the minimum cmake version to 3.5
refactor(cmake): Allow targets to be enabled individually Each major target of polybar can now be enabled/disabled while configuring (even polybar itself). The cmake code specific to each target will only run if the target is enabled. This allows us to for example just build the documentation without having to run all the cmake code related to compilation or having the polybar dependencies installed (other than sphinx).
2020-12-22 02:43:06 +00:00
- The `BUILD_IPC_MSG` option has been renamed to `BUILD_POLYBAR_MSG`
- Building the documentation is now enabled by default and not just when
`sphinx-build` is found.
- Users can control exactly which targets should be available with the following
cmake options (together with their default value):
- `BUILD_POLYBAR=ON` - Builds the `polybar` executable
- `BUILD_POLYBAR_MSG=ON` - Builds the `polybar-msg` executable
- `BUILD_TESTS=OFF` - Builds the test suite
- `BUILD_DOC=ON` - Builds the documentation
build: Add option to enable/disable html/manpages
2020-12-22 11:29:26 +00:00
- `BUILD_DOC_HTML=BUILD_DOC` - Builds the html documentation (depends on `BUILD_DOC`)
- `BUILD_DOC_MAN=BUILD_DOC` - Builds the manpages (depends on `BUILD_DOC`)
Cleanup
2020-12-24 01:02:53 +00:00
- `BUILD_CONFIG=ON` - Generates sample config
- `BUILD_SHELL=ON` - Generates shell completion files
refactor(cmake): Allow targets to be enabled individually Each major target of polybar can now be enabled/disabled while configuring (even polybar itself). The cmake code specific to each target will only run if the target is enabled. This allows us to for example just build the documentation without having to run all the cmake code related to compilation or having the polybar dependencies installed (other than sphinx).
2020-12-22 02:43:06 +00:00
- `DISABLE_ALL=OFF` - Disables all above targets by default. Individual
targets can still be enabled explicitly.
- The documentation can no longer be built by directly configuring the `doc`
directory.
Cleanup
2020-12-24 01:02:53 +00:00
- The sample config file is now placed in the `generated-sources` folder inside
whatever folder you invoked `cmake` from instead of in the root folder of the
repository.
build: Bump cmake version to 3.5.0 This includes the changes from polybar/xpp#30 which also updates the minimum cmake version in the xpp submodule
2020-12-22 00:58:21 +00:00
Adopt "keep a changelog" (#2308) * Adopt keep a changelog Ref: https://keepachangelog.com/en/1.0.0/ * Add changelog to release and contributing docs * Use H2 for automatically added Download section The individual changelog subsections use H3 and the changelog section uses H2, so the Download section should use the same heading * Add already present changes to changelog * Mention changelog issue references in CONTRIBUTING.md
2020-12-16 15:04:10 +00:00
### Added
Add initial support for an escape character (#2361) Add a config parser method which, for now, deals only with escaping the literal backslash character and logs an error message to inform the user of the coming change. The error message includes a properly escaped value for the user. As a result of introducing an escape character('\'): - Warn the user of any unescaped backslashes, as they will not be treated as a literal character in the future - For now, still treat a single backslash as a literal character - Treat two consecutive backslashes as a single properly escaped literal backslash Also: - Add documentation about the escape character to polybar(5) manpage - Add info about the escape character to changelog - Add testcases for ParseLineKeyTest - Add new test ParseEscapedValueTest Resolves: First step in #2354 Improve value parsing - Take value arg in as an rvalue reference and move parsed value back - Remove unnecessary if statement - Rename function - Improve error message - Improve function description - Format Add escape character documentation to manpages Add information about the escape character to the polybar(5) manpage. Add info about the esacape character to changelog Add test cases for ParseLineKeyTest Fix ParseLineKeyTest test cases Also make config parser method parse_escaped_value private. Add tests for escaped_value_parser method Also remove unsued include statement Simplify parse_escaped_value in config_parser Remove unnecessary escaped value generation, so we do not have to keep track of index differences. Fix ParseEscapedValueTest test cases Fix parse_escaped_value Add more test cases for ParseLineKeyTest Update CHANGELOG.md Co-authored-by: Patrick Ziegler <p.ziegler96@gmail.com> Adress review - Adjust documentation - Small code changes Improve parse_escaped_value Add initial support for an escape character Add a config parser method which, for now, deals only with escaping the literal backslash character and logs an error message to inform the user of the coming change. The error message includes a properly escaped value for the user. As a result of introducing an escape character('\'): - Warn the user of any unescaped backslashes, as they will not be treated as a literal character in the future - For now, still treat a single backslash as a literal character - Treat two consecutive backslashes as a single properly escaped literal backslash Resolves: First step in #2354 Improve value parsing - Take value arg in as an rvalue reference and move parsed value back - Remove unnecessary if statement - Rename function - Improve error message - Improve function description - Format Add info about the esacape character to changelog Add test cases for ParseLineKeyTest Fix ParseLineKeyTest test cases Also make config parser method parse_escaped_value private. Add tests for escaped_value_parser method Also remove unsued include statement Simplify parse_escaped_value in config_parser Remove unnecessary escaped value generation, so we do not have to keep track of index differences. Fix ParseEscapedValueTest test cases Add more test cases for ParseLineKeyTest Adress review - Adjust documentation - Small code changes Remove duplicate testcase from ParseLineKeyTest Add initial support for an escape character Add a config parser method which, for now, deals only with escaping the literal backslash character and logs an error message to inform the user of the coming change. The error message includes a properly escaped value for the user. As a result of introducing an escape character('\'): - Warn the user of any unescaped backslashes, as they will not be treated as a literal character in the future - For now, still treat a single backslash as a literal character - Treat two consecutive backslashes as a single properly escaped literal backslash Resolves: First step in #2354 Improve value parsing - Take value arg in as an rvalue reference and move parsed value back - Remove unnecessary if statement - Rename function - Improve error message - Improve function description - Format Fix ParseLineKeyTest test cases Also make config parser method parse_escaped_value private. Remove duplicate testcase from ParseLineKeyTest
2021-01-26 18:16:29 +00:00
- The backslash escape character (\\).
[`#2354`](https://github.com/polybar/polybar/issues/2354)
Adopt "keep a changelog" (#2308) * Adopt keep a changelog Ref: https://keepachangelog.com/en/1.0.0/ * Add changelog to release and contributing docs * Use H2 for automatically added Download section The individual changelog subsections use H3 and the changelog section uses H2, so the Download section should use the same heading * Add already present changes to changelog * Mention changelog issue references in CONTRIBUTING.md
2020-12-16 15:04:10 +00:00
- Warn states for the cpu, memory, fs, and battery modules.
([`#570`](https://github.com/polybar/polybar/issues/570),
[`#956`](https://github.com/polybar/polybar/issues/956),
[`#1871`](https://github.com/polybar/polybar/issues/1871),
[`#2141`](https://github.com/polybar/polybar/issues/2141))
feat(config): Try to load config.ini (#2324) * Added .ini extension check to default config * Added change to changelog and man page * Added change to changelog and man page * removed .vscode folder * removed new lines in changelog
2020-12-23 16:52:30 +00:00
- `internal/battery`: `format-low`, `label-low`, `animation-low`, `low-at = 10`.
Adopt "keep a changelog" (#2308) * Adopt keep a changelog Ref: https://keepachangelog.com/en/1.0.0/ * Add changelog to release and contributing docs * Use H2 for automatically added Download section The individual changelog subsections use H3 and the changelog section uses H2, so the Download section should use the same heading * Add already present changes to changelog * Mention changelog issue references in CONTRIBUTING.md
2020-12-16 15:04:10 +00:00
- `internal/cpu`: `format-warn`, `label-warn`, `warn-percentage = 80`
- `internal/fs`: `format-warn`, `label-warn`, `warn-percentage = 90`
- `internal/memory`: `format-warn`, `label-warn`, `warn-percentage = 90`
- Per-corner corner radius with `radius-{bottom,top}-{left,right}`
([`#2294`](https://github.com/polybar/polybar/issues/2294))
- `internal/network`: `speed-unit = B/s` can be used to customize how network
speeds are displayed.
feat(xkeyboard): Add variant support to layout label (#2163) * Add variant support to xkeyboard layout label Solves #316 * Run style checks, I guess? * Add comment * Return nothing if there is no variant * Update CHANGELOG
2020-12-19 17:22:27 +00:00
- `internal/xkeyboard`: `%variant%` can be used to parse the layout variant
([`#316`](https://github.com/polybar/polybar/issues/316))
feat(config): Try to load config.ini (#2324) * Added .ini extension check to default config * Added change to changelog and man page * Added change to changelog and man page * removed .vscode folder * removed new lines in changelog
2020-12-23 16:52:30 +00:00
- Added .ini extension check to the default config search.
([`#2323`](https://github.com/polybar/polybar/issues/2323))
feat: Module Visibility (#2320) Modules can now also be shown and hidden using ipc commands: $ polybar-msg [-p PID] cmd hide.mymodule # Hides module mymodule $ polybar-msg [-p PID] cmd show.mymodule # Shows module mymodule $ polybar-msg [-p PID] cmd toggle.mymodule # Toggles visibility of mymodule * Hopefully implement visibility checking * Implement hide command * Implement `show` and `toggle` commands * Refactor and add some logging * Run style checks and update CHANGELOG * Get around unused parameter warnings * Change `set_visible` to return nothing * Make errors more informative Co-authored-by: Patrick Ziegler <p.ziegler96@gmail.com> * Update bar when changing module visibility - Called in the module to maintain dependence on the signal emitter - Update CHANGELOG to make changes more verbose * wrong var * Update include/modules/unsupported.hpp Co-authored-by: Patrick Ziegler <p.ziegler96@gmail.com> Co-authored-by: Patrick Ziegler <p.ziegler96@gmail.com>
2020-12-27 15:05:26 +00:00
- IPC commands to change visibility of modules
(`hide.<name>`, `show.<name>`, and `toggle.<name>`)
([`#2108`](https://github.com/polybar/polybar/issues/2108))
Add config option for visiblity (#2320 cont'd) (#2342) * Add option * Undo my havoc on the example config * Update CHANGELOG
2021-01-03 01:43:50 +00:00
- Config option to hide a certain module
(`hidden = false`)
([`#2108`](https://github.com/polybar/polybar/issues/2108))
feat(xworkspaces): Persistent urgent hint (#2340) * add urgent hint * feat(xworkspaces): Fully implement urgency hint Co-authored-by: Jérôme BOULMIER <jerome.boulmier@outlook.fr>
2020-12-31 14:49:39 +00:00
- `internal/xworkspaces`: Make the urgent hint persistent
([`#1081`](https://github.com/polybar/polybar/issues/1081))
feat(net): interface discovery (#2025)
2021-01-03 10:48:15 +00:00
- `internal/network`: `interface-type` may be used in place of `interface` to
automatically select a network interface
([`#2025`](https://github.com/polybar/polybar/pull/2025))
Add support for %nwin% in xworkspaces label (#2329) %nwin% tells the number of windows in a workspace
2021-01-04 09:17:27 +00:00
- `internal/xworkspaces`: `%nwin%` can be used to display the number of open
windows per workspace
([`#604`](https://github.com/polybar/polybar/issues/604))
Adopt "keep a changelog" (#2308) * Adopt keep a changelog Ref: https://keepachangelog.com/en/1.0.0/ * Add changelog to release and contributing docs * Use H2 for automatically added Download section The individual changelog subsections use H3 and the changelog section uses H2, so the Download section should use the same heading * Add already present changes to changelog * Mention changelog issue references in CONTRIBUTING.md
2020-12-16 15:04:10 +00:00
### Changed
- Slight changes to the value ranges the different ramp levels are responsible
for in the cpu, memory, fs, and battery modules. The first and last level are
only used for everything at or below and at and above the edges of the value
range, respectively. The other levels are evenly distributed over the value
range as before.
- `custom/script`: `interval` now defaults to 0 if `tail = true` as per the
documentation.
- `internal/network`:
- Increased precision for upload and download speeds: 0 decimal places for
KB/s (as before), 1 for MB/s and 2 for GB/s.
New Tag Parser (#2303) * refactor(color): Use enum class for color type * Add testcases for tag parser * Make tag parser a pull-style parser Being able to parse single elements at a time gives us more fine-grained error messages, we can also parse as much as possible and only stop after an exception. * fix(color): Parser did not check for invalid chars * tag parser: First full implementation * tag parser: Fix remaining failing tests * tag parser: Replace old parser * tag parser: Treat alignment as formatting tag Makes the structure less complex and the alignment tags really are formatting tags, they are structurally no different from the %{R} tag. * tag parser: Cleanup type definitions All type definitions for tags now live in tags/types.hpp, the parser.hpp only contains the definitions necessary for actually calling the parser, this shouldn't be included in many places (only places that actually do parsing). But many places need the definitions for the tags themselves. * Rename components/parser to tags/dispatch * tag parser: Cleanup * Add changelog
2020-12-17 19:37:28 +00:00
### Fixed
xkeyboard: Fix indicator spacing (#2306) * Fix xkeyboard module spacing between the layout and indicators when indicators are empty. * Simplify the empty label check. * Remove permanently enabled SCROLL_LOCK, sorry. * Another mistake. * Update src/modules/xkeyboard.cpp Co-authored-by: Patrick Ziegler <p.ziegler96@gmail.com> * Update src/modules/xkeyboard.cpp Co-authored-by: Patrick Ziegler <p.ziegler96@gmail.com> * Update. * Fix xkeyboard module spacing between the layout and indicators, when indicators are empty. And fix the spacing between indicators when some are empty. * Add issue #2292 to fixed. * Update CHANGELOG.md Co-authored-by: Filip Banák <6111455-Filip62@users.noreply.gitlab.com> Co-authored-by: Patrick Ziegler <p.ziegler96@gmail.com>
2020-12-17 19:49:10 +00:00
- Trailing space after the layout label when indicators are empty and made sure right amount
of spacing is added between the indicator labels, in the xkeyboard module.
([`#2292`](https://github.com/polybar/polybar/issues/2292))
New Tag Parser (#2303) * refactor(color): Use enum class for color type * Add testcases for tag parser * Make tag parser a pull-style parser Being able to parse single elements at a time gives us more fine-grained error messages, we can also parse as much as possible and only stop after an exception. * fix(color): Parser did not check for invalid chars * tag parser: First full implementation * tag parser: Fix remaining failing tests * tag parser: Replace old parser * tag parser: Treat alignment as formatting tag Makes the structure less complex and the alignment tags really are formatting tags, they are structurally no different from the %{R} tag. * tag parser: Cleanup type definitions All type definitions for tags now live in tags/types.hpp, the parser.hpp only contains the definitions necessary for actually calling the parser, this shouldn't be included in many places (only places that actually do parsing). But many places need the definitions for the tags themselves. * Rename components/parser to tags/dispatch * tag parser: Cleanup * Add changelog
2020-12-17 19:37:28 +00:00
- Parser error if click command contained `}`
([`#2040`](https://github.com/polybar/polybar/issues/2040))
Release 3.5.4
2021-01-07 12:44:30 +00:00
## [3.5.4] - 2021-01-07
Remove tag compaction "optimizations" The intention was to remove tags that won't have an effect and join together consecutive tags. However the patterns used can just as well appear in regular text, so this can replace characters inside user defined text and not just formatting tags. Fixes #2331
2020-12-24 22:52:35 +00:00
### Fixed
- Wrong text displayed if module text ends with `}` ([`#2331`](https://github.com/polybar/polybar/issues/2331))
Release 3.5.3
2020-12-23 16:32:15 +00:00
## [3.5.3] - 2020-12-23
### Build
Remove tag compaction "optimizations" The intention was to remove tags that won't have an effect and join together consecutive tags. However the patterns used can just as well appear in regular text, so this can replace characters inside user defined text and not just formatting tags. Fixes #2331
2020-12-24 22:52:35 +00:00
- Don't use `git` when building documentation ([`#2309`](https://github.com/polybar/polybar/issues/2309))
Release 3.5.3
2020-12-23 16:32:15 +00:00
### Fixed
- Empty color values are no longer treated as invalid and no longer produce an error.
Release 3.5.4
2021-01-07 12:44:30 +00:00
[Unreleased]: https://github.com/polybar/polybar/compare/3.5.4...HEAD
[3.5.4]: https://github.com/polybar/polybar/releases/tag/3.5.4
cmake: Add option to enable/disable sample config
2020-12-23 23:56:31 +00:00
[3.5.3]: https://github.com/polybar/polybar/releases/tag/3.5.3