aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSean Whitton <spwhitton@spwhitton.name>2022-08-06 10:27:30 -0700
committerSean Whitton <spwhitton@spwhitton.name>2022-08-06 10:27:30 -0700
commit8b0b1287ab124a908bb5414a7578eabc66b149bf (patch)
tree82b684e0d902ed17face7c5a7d101436515509c2
parentd346e769f49b9dcad1840036b38cd07e067a7e8b (diff)
downloadconsfigurator-8b0b1287ab124a908bb5414a7578eabc66b149bf.tar.gz
FILE:SYMLINKED: document that the link target is literal
Reported-by: Andreas Reuleaux <rx@a-rx.info> Signed-off-by: Sean Whitton <spwhitton@spwhitton.name>
-rw-r--r--src/property/file.lisp7
1 files changed, 6 insertions, 1 deletions
diff --git a/src/property/file.lisp b/src/property/file.lisp
index 5f0f480..9712571 100644
--- a/src/property/file.lisp
+++ b/src/property/file.lisp
@@ -224,7 +224,12 @@ Uses CL-PPCRE:REGEX-REPLACE, which see for the syntax of REPLACE."
(defprop symlinked :posix (&key from to)
"Ensure FROM is a symlink to TO. Symbolic links are overwritten; it is an
-error if FROM is another kind of file, except when unapplying."
+error if FROM is another kind of file, except when unapplying.
+
+The link target, TO, is literal: if it is a relative path, then it is not
+relative to the remote home directory, but instead relative to the directory
+that contains FROM. To create a link with a target under the remote home
+directory, you can use one or more '../', or an absolute path."
(:desc #?"Symlinked ${from} -> ${to}")
(:apply
(unless (and from to)