aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDudemanguy <random342@airmail.cc>2021-12-19 14:06:17 -0600
committerEli Schwartz <eschwartz93@gmail.com>2022-02-28 00:23:14 -0500
commite7b8059f7bd01680c29faf3a0f4538a29c4b4938 (patch)
treec80fcc3c210ea9254586cbf1c0729e176ece3aa5 /docs
parentfc5dfb852b90ec8e5c266751eda7710bb2b96160 (diff)
downloadmeson-e7b8059f7bd01680c29faf3a0f4538a29c4b4938.zip
meson-e7b8059f7bd01680c29faf3a0f4538a29c4b4938.tar.gz
meson-e7b8059f7bd01680c29faf3a0f4538a29c4b4938.tar.bz2
docs: correct the shaderc documentation
The documentation on how shaderc is checked in meson was quite behind. Update it to mention that pkg-config is the default and preferred method of checking. Also be specific about what order everything is checked in since shaderc is confusing.
Diffstat (limited to 'docs')
-rw-r--r--docs/markdown/Dependencies.md16
1 files changed, 11 insertions, 5 deletions
diff --git a/docs/markdown/Dependencies.md b/docs/markdown/Dependencies.md
index 9dabef8..3b6b212 100644
--- a/docs/markdown/Dependencies.md
+++ b/docs/markdown/Dependencies.md
@@ -678,11 +678,17 @@ or as an OSX framework.
*(added 0.51.0)*
-Shaderc currently does not ship with any means of detection.
-Nevertheless, Meson can try to detect it using `pkg-config`, but will
-default to looking for the appropriate library manually. If the
-`static` keyword argument is `true`, `shaderc_combined` is preferred.
-Otherwise, `shaderc_shared` is preferred. Note that it is not possible
+Meson will first attempt to find shaderc using `pkg-config`. Upstream
+currently ships three different `pkg-config` files and by default will
+check them in this order: `shaderc`, `shaderc_combined`, and
+`shaderc_static`. If the `static` keyword argument is `true`, then
+Meson instead checks in this order: `shaderc_combined`, `shaderc_static`,
+and `shaderc`.
+
+If no `pkg-config` file is found, then Meson will try to detect the
+library manually. In this case, it will try to link against either
+`-lshaderc_shared` or `-lshaderc_combined`, preferring the latter
+if the static keyword argument is true. Note that it is not possible
to obtain the shaderc version using this method.
`method` may be `auto`, `pkg-config` or `system`.