diff options
Diffstat (limited to 'docs/markdown/Run-targets.md')
| -rw-r--r-- | docs/markdown/Run-targets.md | 27 |
1 files changed, 21 insertions, 6 deletions
diff --git a/docs/markdown/Run-targets.md b/docs/markdown/Run-targets.md index b584bf7..04959ab 100644 --- a/docs/markdown/Run-targets.md +++ b/docs/markdown/Run-targets.md @@ -4,9 +4,13 @@ short-description: Targets to run external commands # Run targets -Sometimes you need to have a target that just runs an external command. As an example you might have a build target that reformats your source code, runs `cppcheck` or something similar. In Meson this is accomplished with a so called *run target*. +Sometimes you need to have a target that just runs an external +command. As an example you might have a build target that reformats +your source code, runs `cppcheck` or something similar. In Meson this +is accomplished with a so called *run target*. -The recommended way of doing this is writing the command(s) you want to run to a script file. Here's an example script. +The recommended way of doing this is writing the command(s) you want +to run to a script file. Here's an example script. ```bash #!/bin/sh @@ -15,11 +19,21 @@ cd "${MESON_SOURCE_ROOT}" inspector_command -o "${MESON_BUILD_ROOT}/inspection_result.txt" ``` -Note the two environment variables `MESON_SOURCE_ROOT` and `MESON_BUILD_ROOT`. These are absolute paths to your project's source and build directories and they are automatically set up by Meson. In addition to these Meson also sets up the variable `MESON_SUBDIR`, which points to the subdirectory where the run command was specified. Most commands don't need to set up this. +Note the two environment variables `MESON_SOURCE_ROOT` and +`MESON_BUILD_ROOT`. These are absolute paths to your project's source +and build directories and they are automatically set up by Meson. In +addition to these Meson also sets up the variable `MESON_SUBDIR`, +which points to the subdirectory where the run command was specified. +Most commands don't need to set up this. -Note how the script starts by cd'ing into the source dir. Meson does not guarantee that the script is run in any specific directory. Whether you need to do the same depends on what your custom target wants to do. +Note how the script starts by cd'ing into the source dir. Meson does +not guarantee that the script is run in any specific directory. +Whether you need to do the same depends on what your custom target +wants to do. -To make this a run target we write it to a script file called `scripts/inspect.sh` and specify it in the top level Meson file like this. +To make this a run target we write it to a script file called +`scripts/inspect.sh` and specify it in the top level Meson file like +this. ```meson run_target('inspector', @@ -32,7 +46,8 @@ Run targets are not run by default. To run it run the following command. $ meson compile inspector ``` -All additional entries in `run_target`'s `command` array are passed unchanged to the inspector script, so you can do things like this: +All additional entries in `run_target`'s `command` array are passed +unchanged to the inspector script, so you can do things like this: ```meson run_target('inspector', |