aboutsummaryrefslogtreecommitdiff
path: root/src/connection
diff options
context:
space:
mode:
authorSean Whitton <spwhitton@spwhitton.name>2022-04-13 17:26:57 -0700
committerSean Whitton <spwhitton@spwhitton.name>2022-04-13 17:35:10 -0700
commit2726ced1199b3b6d4452cbcefd6539bd854b4509 (patch)
treeba24a6566976ffcd76d976902b1ad2c516fd9a7f /src/connection
parent8128937f6e9c8eb7898afad8b93451634a7150e7 (diff)
downloadconsfigurator-2726ced1199b3b6d4452cbcefd6539bd854b4509.tar.gz
REHOME-CONNECTION: expand documentation for DATADIR slot
Signed-off-by: Sean Whitton <spwhitton@spwhitton.name>
Diffstat (limited to 'src/connection')
-rw-r--r--src/connection/rehome.lisp6
1 files changed, 5 insertions, 1 deletions
diff --git a/src/connection/rehome.lisp b/src/connection/rehome.lisp
index 791b3b4..ecb2816 100644
--- a/src/connection/rehome.lisp
+++ b/src/connection/rehome.lisp
@@ -22,7 +22,11 @@
((datadir
:type :string :initarg :datadir :reader datadir
:documentation
- "Where Consfigurator would cache items of prerequisite data in the new HOME."))
+ "Where Consfigurator would cache items of prerequisite data in the new HOME,
+as accessible from the previous connection hop.
+
+In the case of a connection which chroots, for example, this will be the path
+to a directory inside the chroot as seen from outside the chroot."))
(:documentation
"A connection which works by switching to a new HOME on the same host."))