diff options
author | Sean Whitton <spwhitton@spwhitton.name> | 2021-12-15 15:52:04 -0700 |
---|---|---|
committer | Sean Whitton <spwhitton@spwhitton.name> | 2021-12-15 15:52:04 -0700 |
commit | 8be8d72a06c15cea200c36186f15bc4b4ff8540a (patch) | |
tree | 9ba836e866f86139afcfbb465e18334838bcfc8a | |
parent | 21cb78ab1a9c42f519e93ca8b441b058b50ae42d (diff) | |
download | consfigurator-8be8d72a06c15cea200c36186f15bc4b4ff8540a.tar.gz |
DATA.FILES-TREE docstring: minor formatting and wording changes
Signed-off-by: Sean Whitton <spwhitton@spwhitton.name>
-rw-r--r-- | src/data/files-tree.lisp | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/src/data/files-tree.lisp b/src/data/files-tree.lisp index 26c41e3..0845e45 100644 --- a/src/data/files-tree.lisp +++ b/src/data/files-tree.lisp @@ -21,13 +21,16 @@ (defmethod register-data-source ((type (eql :files-tree)) &key location) "Provide the contents of a local directory on the machine running the root Lisp. Register this data source multiple times to provide multiple trees. + LOCATION is either a designator for a pathname representing the root of the tree of files or a symbol which designates an ASDF package where the tree is -contained in the subdirectory `data/'. IDEN1 specifies a subdirectory under -LOCATION and IDEN2 a relative path within that subdirectory. For convenience -IDEN1 and IDEN2 may be passed as absolute and will be converted to relative -paths. The usual cases of IDEN1 as a hostname or a `_' prefixed identifier, -and IDEN2 an an absolute or relative path are all supported." +contained in the subdirectory 'data/'. + +IDEN1 specifies a subdirectory under LOCATION and IDEN2 a relative path within +that subdirectory. For convenience IDEN1 and IDEN2 may be passed as absolute +and will be converted to relative paths. The usual cases of IDEN1 as a +hostname, IDEN1 as an underscore-prefixed identifier, and IDEN2 an an absolute +or relative path are all supported." (let ((base-path (if (symbolp location) (asdf:system-relative-pathname location "data/") (ensure-directory-pathname location)))) |