# HG changeset patch
# User Franz Glasner <fzglas.hg@dom66.de>
# Date 1686362920 -7200
# Node ID 7c41a52253bf34caa1db5c58b50d4677ae0763c9
# Parent  6a55cbc836f16f644c007e6e1dcece5fa380076d
Docs

diff -r 6a55cbc836f1 -r 7c41a52253bf CHANGES.txt
--- a/CHANGES.txt	Sat Jun 10 03:56:17 2023 +0200
+++ b/CHANGES.txt	Sat Jun 10 04:08:40 2023 +0200
@@ -17,6 +17,8 @@
 
 - **[feature}**
   Jails now support references at their roots: they act like a symbolic link.
+  This can be controlled by a new `resolve_ref` keyword argument to
+  :py:meth:`configmix.config.Configuration.jailed`.
 
 
 0.21.2 (2023-04-12)
diff -r 6a55cbc836f1 -r 7c41a52253bf docs/introduction.rst
--- a/docs/introduction.rst	Sat Jun 10 03:56:17 2023 +0200
+++ b/docs/introduction.rst	Sat Jun 10 04:08:40 2023 +0200
@@ -357,6 +357,8 @@
 
    Must be Filters are **not** supported.
 
+   Think of them as symbolic links.
+
 3. The namespace ``OS``
 
    Available functions:
@@ -638,6 +640,13 @@
 .. note:: A jailed configuration holds a strong reference to the unjailed
           base configuration.
 
+.. note:: If a jail's root path points to a location with a variable
+          substitutions the jail does not work: it is not possible to
+          expand the substitution.
+
+          Using ``ref`` namespaces instead works: think of
+          symbolic links.
+
 
 Custom filename extensions and custom loaders
 ---------------------------------------------