aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNirbheek Chauhan <nirbheek.chauhan@gmail.com>2017-10-03 05:49:24 +0000
committerGitHub <noreply@github.com>2017-10-03 05:49:24 +0000
commitf10b15930bb40424df0d0254ea5576b24b3c10df (patch)
tree8f7e8a6619af645a181882fcc3ff2b339715c908
parenta28db4577a36bf53f09e439f2032f28eb9cd7079 (diff)
downloadmeson-f10b15930bb40424df0d0254ea5576b24b3c10df.zip
meson-f10b15930bb40424df0d0254ea5576b24b3c10df.tar.gz
meson-f10b15930bb40424df0d0254ea5576b24b3c10df.tar.bz2
Update Reference-manual.md
Fix documentation breakage from https://github.com/mesonbuild/meson/pull/2415
-rw-r--r--docs/markdown/Reference-manual.md15
1 files changed, 11 insertions, 4 deletions
diff --git a/docs/markdown/Reference-manual.md b/docs/markdown/Reference-manual.md
index 86ad15e..0cc6771 100644
--- a/docs/markdown/Reference-manual.md
+++ b/docs/markdown/Reference-manual.md
@@ -820,11 +820,18 @@ static with only one option.
The keyword arguments for this are the same as for [`executable`](#executable) with the following additions:
+- `name_prefix` the string that will be used as the prefix for the
+ target output filename by overriding the default (only used for
+ libraries). By default this is `lib` on all platforms and compilers
+ except with MSVC where it is omitted to follow convention.
- `name_suffix` the string that will be used as the suffix for the
- target by overriding the default (only used for libraries). By
- default this is `lib` on all platforms and compilers except with
- MSVC where it is omitted and set to `a` to avoid potential name clash
- with shared libraries (which also generates `lib` files).
+ target output filename by overriding the default (see also:
+ [executable()](#executable)). By default, for shared libraries this
+ is `dylib` on macOS, `dll` on Windows, and `so` everywhere else.
+ For static libraries, it is `a` everywhere. By convention MSVC
+ static libraries use the `lib` suffix, but we use `a` to avoid a
+ potential name clash with shared libraries which also generate
+ `xxx.lib` import files.
- `rust_crate_type` specifies the crate type for Rust
libraries. Defaults to `dylib` for shared libraries and `rlib` for
static libraries.