diff options
| author | Nirbheek Chauhan <nirbheek@centricular.com> | 2025-07-28 22:36:35 +0530 |
|---|---|---|
| committer | Eli Schwartz <eschwartz93@gmail.com> | 2025-07-28 13:13:19 -0400 |
| commit | 189c27ef815b717a854d2ecdda1851463a5deff3 (patch) | |
| tree | e8db1362373a3c592ae1912668c9c0bef446f2e5 /docs/yaml | |
| parent | 555df4d863793027df8fca6d3eb6e18295770831 (diff) | |
| download | meson-189c27ef815b717a854d2ecdda1851463a5deff3.tar.gz | |
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 https://github.com/mesonbuild/meson/issues/14843
Diffstat (limited to 'docs/yaml')
| -rw-r--r-- | docs/yaml/functions/configure_file.yaml | 2 | ||||
| -rw-r--r-- | docs/yaml/functions/custom_target.yaml | 2 | ||||
| -rw-r--r-- | docs/yaml/functions/install_data.yaml | 3 | ||||
| -rw-r--r-- | docs/yaml/functions/install_headers.yaml | 4 |
4 files changed, 11 insertions, 0 deletions
diff --git a/docs/yaml/functions/configure_file.yaml b/docs/yaml/functions/configure_file.yaml index 943ad2289..2deeff445 100644 --- a/docs/yaml/functions/configure_file.yaml +++ b/docs/yaml/functions/configure_file.yaml @@ -16,6 +16,8 @@ description: | it takes any source or configured file as the `input:` and assumes that the `output:` is produced when the specified command is run. + You can install the outputted file with the `install_dir:` kwarg, see below. + *(since 0.47.0)* When the `copy:` keyword argument is set to `true`, this function will copy the file provided in `input:` to a file in the build directory with the name `output:` in the current directory. diff --git a/docs/yaml/functions/custom_target.yaml b/docs/yaml/functions/custom_target.yaml index 492040704..094787bbe 100644 --- a/docs/yaml/functions/custom_target.yaml +++ b/docs/yaml/functions/custom_target.yaml @@ -12,6 +12,8 @@ description: | custom_target('foo', output: 'file.txt', ...) ``` + 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 output (`file.txt` in the example above). diff --git a/docs/yaml/functions/install_data.yaml b/docs/yaml/functions/install_data.yaml index fdedf7e2f..b9aedca84 100644 --- a/docs/yaml/functions/install_data.yaml +++ b/docs/yaml/functions/install_data.yaml @@ -2,6 +2,9 @@ name: install_data returns: void description: | Installs files from the source tree that are listed as positional arguments. + Please note that this can only install static files from the source tree. + Generated files are installed via the `install_dir:` kwarg on the respective + generators, such as `custom_target()` or `configure_file(). See [Installing](Installing.md) for more examples. diff --git a/docs/yaml/functions/install_headers.yaml b/docs/yaml/functions/install_headers.yaml index da304bc3a..42f64624b 100644 --- a/docs/yaml/functions/install_headers.yaml +++ b/docs/yaml/functions/install_headers.yaml @@ -9,6 +9,10 @@ description: | argument. As an example if this has the value `myproj` then the headers would be installed to `/{prefix}/include/myproj`. + Please note that this can only install static files from the source tree. + Generated files are installed via the `install_dir:` kwarg on the respective + generators, such as `custom_target()` or `configure_file(). + example: | For example, this will install `common.h` and `kola.h` into `/{prefix}/include`: |