Skip to content

Commit

Permalink
Changed documentation for glob paths.
Browse files Browse the repository at this point in the history
  • Loading branch information
OliverLok committed Dec 3, 2024
1 parent e0a2c0b commit b1b2dfb
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions docs/types.md
Original file line number Diff line number Diff line change
Expand Up @@ -784,10 +784,9 @@ All types of FileSpecs share some common fields:
### FileSpec -- Path

A FileSpec with `type` equal to `path` points to an absolute or relative path accessible from the current machine.
The path may also include a glob pattern to target multiple files or directories.
For paths that match multiple dirents, the dirents will be copied into `dest` only if `dest` is a directory.
If `dest` does not exist, it will be automatically created as a directory.
Attempting to copy multiple dirents into `dest` if `dest` is an existing file will result in an error.
The path may include a glob pattern to target multiple files or directories.
Multiple dirents are copied into `dest` if it's a directory (or will be created as a directory if it doesn’t exist).
An error occurs if multiple dirents try to get copied into an existing file.
When a relative path is specified, additional context is required to know the relative base.
For example, a FileSpec in an assignment config is relative to the assignment directory (the directory where the `assignment.json` file lives).

Expand Down

0 comments on commit b1b2dfb

Please sign in to comment.