Merge pull request #6421 from dcbaker/zlib-system-dep

Add a "system" dependency for zlib

2 files changed, 19 insertions, 0 deletions

diff --git a/docs/markdown/Dependencies.md b/docs/markdown/Dependencies.md
index cf2744f..50ea92f 100644
--- a/docs/markdown/Dependencies.md
+++ b/docs/markdown/Dependencies.md
@@ -572,6 +572,17 @@ that it is not possible to obtain the shaderc version using this method.
 
 `method` may be `auto`, `pkg-config` or `system`.
 
+## Zlib
+
+Zlib ships with pkg-config and cmake support, but on some operating systems
+(windows, macOs, FreeBSD, dragonflybsd), it is provided as part of the base
+operating system without pkg-config support. The new System finder can be used
+on these OSes to link with the bundled version.
+
+`method` may be `auto`, `pkg-config`, `cmake`, or `system`.
+
+*New in 0.54.0* the `system` method.
+
 <hr>
 <a name="footnote1">1</a>: They may appear to be case-insensitive, if the
     underlying file system happens to be case-insensitive.
diff --git a/docs/markdown/snippets/zlib_system_dependency.md b/docs/markdown/snippets/zlib_system_dependency.md
new file mode 100644
index 0000000..5bdabf3
--- /dev/null
+++ b/docs/markdown/snippets/zlib_system_dependency.md
@@ -0,0 +1,8 @@
+## Add a system type dependency for zlib
+
+This allows zlib to be detected on macOS and FreeBSD without the use of
+pkg-config or cmake, neither of which are part of the base install on those
+OSes (but zlib is).
+
+A side effect of this change is that `dependency('zlib')` also works with
+cmake instead of requiring `dependency('ZLIB')`.