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.
pull/10047/head
Dudemanguy 3 years ago committed by Eli Schwartz
parent fc5dfb852b
commit e7b8059f7b
  1. 16
      docs/markdown/Dependencies.md

@ -678,11 +678,17 @@ or as an OSX framework.
*(added 0.51.0)* *(added 0.51.0)*
Shaderc currently does not ship with any means of detection. Meson will first attempt to find shaderc using `pkg-config`. Upstream
Nevertheless, Meson can try to detect it using `pkg-config`, but will currently ships three different `pkg-config` files and by default will
default to looking for the appropriate library manually. If the check them in this order: `shaderc`, `shaderc_combined`, and
`static` keyword argument is `true`, `shaderc_combined` is preferred. `shaderc_static`. If the `static` keyword argument is `true`, then
Otherwise, `shaderc_shared` is preferred. Note that it is not possible 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. to obtain the shaderc version using this method.
`method` may be `auto`, `pkg-config` or `system`. `method` may be `auto`, `pkg-config` or `system`.

Loading…
Cancel
Save