From df6590abfc650d23532ef097892f61ba6d203c5f Mon Sep 17 00:00:00 2001
From: Robert Helgesson <robert@rycee.net>
Date: Thu, 4 Jan 2018 12:19:34 +0100
Subject: [PATCH] home-environment: describe session variable values a bit

---
 modules/home-environment.nix | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/modules/home-environment.nix b/modules/home-environment.nix
index 61ca0649e..77850a8e3 100644
--- a/modules/home-environment.nix
+++ b/modules/home-environment.nix
@@ -128,6 +128,15 @@ in
       description = ''
         Environment variables to always set at login.
         </para><para>
+        The values may refer to other environment variables using
+        POSIX.2 style variable references. For example, a variable
+        <varname>parameter</varname> may be referenced as
+        <code>$parameter</code> or <code>''${parameter}</code>. A
+        default value <literal>foo</literal> may be given as per
+        <code>''${parameter:-foo}</code> and, similarly, an alternate
+        value <literal>bar</literal> can be given as per
+        <code>''${parameter:+bar}</code>.
+        </para><para>
         Note, these variables may be set in any order so no session
         variable may have a runtime dependency on another session
         variable. In particular code like