From 8bb5d53c5847d9a9b2ad1bda49f9aa9df0de282a Mon Sep 17 00:00:00 2001
From: Andrew Voynov <37143421+Andrew15-5@users.noreply.github.com>
Date: Thu, 10 Oct 2024 22:22:52 +0300
Subject: [PATCH] docs: add XDG_*_HOME mentions to xdg.*Home options

---
 modules/misc/xdg.nix | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/modules/misc/xdg.nix b/modules/misc/xdg.nix
index a47a33f56..b916e88fb 100644
--- 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`.
       '';
     };
   };