diff options
| author | Ivan Molodetskikh <yalterz@gmail.com> | 2025-01-11 09:09:10 +0300 |
|---|---|---|
| committer | Ivan Molodetskikh <yalterz@gmail.com> | 2025-01-11 09:09:25 +0300 |
| commit | 481958f8f78367507382e70d8562fa9507a434d3 (patch) | |
| tree | d0b10c6fcd2d3fa907c8aafa3c23aacc43236c1f | |
| parent | 4094469d596c705de8fe8d4c05edba13fa992b3e (diff) | |
| download | niri-481958f8f78367507382e70d8562fa9507a434d3.tar.gz niri-481958f8f78367507382e70d8562fa9507a434d3.tar.bz2 niri-481958f8f78367507382e70d8562fa9507a434d3.zip | |
wiki: Document version string in Packaging
| -rw-r--r-- | wiki/Packaging-niri.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/wiki/Packaging-niri.md b/wiki/Packaging-niri.md index 7348e032..1dae0a6a 100644 --- a/wiki/Packaging-niri.md +++ b/wiki/Packaging-niri.md @@ -28,6 +28,32 @@ To do that, put files into the correct directories according to this table. Doing this will make niri appear in GDM and other display managers. +### Version string + +The niri version string includes its version and commit hash: + +``` +$ niri --version +niri 25.01 (e35c630) +``` + +When building in a packaging system, there's usually no repository, so the commit hash is unavailable and the version will show "unknown commit". +In this case, please set the commit hash manually: + +``` +$ export NIRI_BUILD_COMMIT="e35c630" +...proceed to build niri +``` + +You can also override the version string entirely, in this case please make sure the corresponding niri version stays intact: + +``` +$ export NIRI_BUILD_VERSION_STRING="25.01-1 (e35c630)" +...proceed to build niri +``` + +Remember to set this variable for both `cargo build` and `cargo install` since the latter will rebuild niri if the environment changes. + ### Panics Good panic backtraces are required for diagnosing niri crashes. |
