mirror of
https://github.com/php/pie.git
synced 2026-03-23 23:12:17 +01:00
Merge pull request #422 from macintoshplus/doc-os-families
Document OS compatibility restrictions for extensions
This commit is contained in:
@@ -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,
|
||||
|
||||
Reference in New Issue
Block a user