diff options
author | Dylan Baker <dylan@pnwbakers.com> | 2018-12-18 13:42:44 -0800 |
---|---|---|
committer | Jussi Pakkanen <jpakkane@gmail.com> | 2018-12-19 01:25:17 +0200 |
commit | 05fc81ac3527e66e8460c6a33c84e83c1e84b63c (patch) | |
tree | 884478bff237c85b2a57bee2f6f001ee8f8676e1 | |
parent | 4ffd009fe930a4996aff22ce23c0fd5dea11ba8b (diff) | |
download | meson-05fc81ac3527e66e8460c6a33c84e83c1e84b63c.tar.gz |
docs: Add warning about not using join_paths() with build targets [skip ci]
This comes up now and again when people try do do something like:
meson.build:
```meson
my_sources = ['foo.c']
subdir('subdir')
executable('foo', my_sources)
```
subdir/meson.build:
```meson
my_sources += ['bar.c']
```
-rw-r--r-- | docs/markdown/Reference-manual.md | 3 | ||||
-rw-r--r-- | docs/markdown/Syntax.md | 8 |
2 files changed, 11 insertions, 0 deletions
diff --git a/docs/markdown/Reference-manual.md b/docs/markdown/Reference-manual.md index 0625f96b7..2fc61d53c 100644 --- a/docs/markdown/Reference-manual.md +++ b/docs/markdown/Reference-manual.md @@ -1022,6 +1022,9 @@ Joins the given strings into a file system path segment. For example individual segments is an absolute path, all segments before it are dropped. That means that `join_paths('foo', '/bar')` returns `/bar`. +**Warning** Don't use `join_paths()` for sources in [`library`](#library) and +[`executable`](#executable), you should use [`files`](#files) instead. + *Added 0.36.0* Since 0.49.0 using the`/` operator on strings is equivalent to calling diff --git a/docs/markdown/Syntax.md b/docs/markdown/Syntax.md index 9ea96c1d9..cf56dd3f4 100644 --- a/docs/markdown/Syntax.md +++ b/docs/markdown/Syntax.md @@ -216,6 +216,14 @@ path = pathsep.join(['/usr/bin', '/bin', '/usr/local/bin']) path = join_paths(['/usr', 'local', 'bin']) # path now has the value '/usr/local/bin' +# Don't use join_paths for sources files, use files for that: +my_sources = files('foo.c') +... +my_sources += files('bar.c') +# This has the advantage of always calculating the correct relative path, even +# if you add files in another directory or use them in a different directory +# than they're defined in + # Example to set an API version for use in library(), install_header(), etc project('project', 'c', version: '0.2.3') version_array = meson.project_version().split('.') |