Skip to content

Commit 189c27e

Browse files
nirbheekeli-schwartz
authored andcommitted
docs: Reduce reading comprehension requirements for install functions
As we are becoming more popular, the docs have to be clearer because we're being exposed to a wider base of users with highly variable English language ability. Some of those can be helped with translations, but for the rest, let's repeat ourselves. Fixes #14843
1 parent 555df4d commit 189c27e

File tree

4 files changed

+11
-0
lines changed

4 files changed

+11
-0
lines changed

docs/yaml/functions/configure_file.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ description: |
1616
it takes any source or configured file as the `input:` and assumes
1717
that the `output:` is produced when the specified command is run.
1818
19+
You can install the outputted file with the `install_dir:` kwarg, see below.
20+
1921
*(since 0.47.0)* When the `copy:` keyword argument is set to `true`,
2022
this function will copy the file provided in `input:` to a file in the
2123
build directory with the name `output:` in the current directory.

docs/yaml/functions/custom_target.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ description: |
1212
custom_target('foo', output: 'file.txt', ...)
1313
```
1414
15+
You can install the outputted files with the `install_dir:` kwarg, see below.
16+
1517
*Since 0.60.0* the name argument is optional and defaults to the basename of the first
1618
output (`file.txt` in the example above).
1719

docs/yaml/functions/install_data.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@ name: install_data
22
returns: void
33
description: |
44
Installs files from the source tree that are listed as positional arguments.
5+
Please note that this can only install static files from the source tree.
6+
Generated files are installed via the `install_dir:` kwarg on the respective
7+
generators, such as `custom_target()` or `configure_file().
58
69
See [Installing](Installing.md) for more examples.
710

docs/yaml/functions/install_headers.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ description: |
99
argument. As an example if this has the value `myproj` then the
1010
headers would be installed to `/{prefix}/include/myproj`.
1111
12+
Please note that this can only install static files from the source tree.
13+
Generated files are installed via the `install_dir:` kwarg on the respective
14+
generators, such as `custom_target()` or `configure_file().
15+
1216
example: |
1317
For example, this will install `common.h` and `kola.h` into
1418
`/{prefix}/include`:

0 commit comments

Comments
 (0)