polybar/CHANGELOG.md

4.1 KiB

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, and this project adheres to Semantic Versioning.

Unreleased

Breaking

  • 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 the minimum cmake version to 3.5
  • 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
    • 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.

Added

  • Warn states for the cpu, memory, fs, and battery modules. (#570, #956, #1871, #2141)
    • internal/battery: format-low, label-low, animation-low, low-at = 10.
    • 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)
  • internal/network: speed-unit = B/s can be used to customize how network speeds are displayed.
  • internal/xkeyboard: %variant% can be used to parse the layout variant (#316)
  • Added .ini extension check to the default config search. (#2323)

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.

Fixed

  • 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)
  • Parser error if click command contained } (#2040)

3.5.3 - 2020-12-23

Build

  • Don't use git when building documentation (#2311)

Fixed

  • Empty color values are no longer treated as invalid and no longer produce an error.