Skip to content

Document that custom_target outputs cannot be in a subdirectory #15058

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 4, 2025
Merged

Document that custom_target outputs cannot be in a subdirectory #15058

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/yaml/functions/custom_target.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ description: |
custom_target('foo', output: 'file.txt', ...)
```

The files passed to `output:` cannot contain path separators. See the
[manual on custom build targets](Custom-build-targets.md#details-on-command-invocation) for
an explanation on where output files should be placed.

You can install the outputted files with the `install_dir:` kwarg, see below.

*Since 0.60.0* the name argument is optional and defaults to the basename of the first
Expand Down Expand Up @@ -217,7 +221,8 @@ kwargs:

output:
type: array[str]
description: Array of output files.
description: |
Array of output files. These cannot contain path separators.

env:
since: 0.57.0
Expand Down
Loading