diff --git a/docs/extension-maintainers.md b/docs/extension-maintainers.md index 6837649b..8d279c63 100644 --- a/docs/extension-maintainers.md +++ b/docs/extension-maintainers.md @@ -241,6 +241,23 @@ change the behaviour of downloading the source package. * `{ExtensionName}-{Version}.tgz` (this is intended for backwards compatibility with PECL packages) +##### `os-families` restrictions + +The `os-families` and `os-families-exclude` directive allow extention maintainers +to restrict the Operating System compatibility. + + * `os-families` An array of OS families to mark as compatible with the extension. + (e.g. `"os-families": ["windows"]` for an extension only available on Windows) + * `os-families-exclude` An array of OS families to mark as incompatible with the + extension. (e.g. `"os-families-exclude": ["windows"]` for an extension that + cannot be installed available on Windows) + +The list of accepted OS families: "windows", "bsd", "darwin", "solaris", "linux", +"unknown" + +> [!WARNING] +> Only one of `os-families` and `os-families-exclude` can be defined. + #### Extension dependencies Extension authors may define some dependencies in `require`, but practically,