Skip to content

Document OS compatibility restrictions for extensions #422

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 20, 2025
Merged

Document OS compatibility restrictions for extensions #422

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d6a347c
Document OS compatibility restrictions for extensions
macintoshplus Nov 20, 2025
863a7b8
Apply suggestions from code review
macintoshplus Nov 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/extension-maintainers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
Loading