From 481958f8f78367507382e70d8562fa9507a434d3 Mon Sep 17 00:00:00 2001
From: Ivan Molodetskikh <yalterz@gmail.com>
Date: Sat, 11 Jan 2025 09:09:10 +0300
Subject: wiki: Document version string in Packaging

---
 wiki/Packaging-niri.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

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.
-- 
cgit