docs: add XDG_*_HOME mentions to xdg.*Home options

colonelpanic8 · Dec 30, 2024 · d4ff261 · d4ff261
1 parent e6132d5
commit d4ff261
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/modules/misc/xdg.nix b/modules/misc/xdg.nix
@@ -30,6 +30,8 @@ in {
       apply = toString;
       description = ''
         Absolute path to directory holding application caches.
+
+        Sets `XDG_CACHE_HOME` for the user if `xdg.enable` is set `true`.
       '';
     };
 
@@ -48,6 +50,8 @@ in {
       apply = toString;
       description = ''
         Absolute path to directory holding application configurations.
+
+        Sets `XDG_CONFIG_HOME` for the user if `xdg.enable` is set `true`.
       '';
     };
 
@@ -67,6 +71,8 @@ in {
       apply = toString;
       description = ''
         Absolute path to directory holding application data.
+
+        Sets `XDG_DATA_HOME` for the user if `xdg.enable` is set `true`.
       '';
     };
 
@@ -86,6 +92,8 @@ in {
       apply = toString;
       description = ''
         Absolute path to directory holding application states.
+
+        Sets `XDG_STATE_HOME` for the user if `xdg.enable` is set `true`.
       '';
     };
   };