Skip to content

Commit a470824

Browse files
committed
Update options.yml documentation
1 parent d81f406 commit a470824

File tree

2 files changed

+43
-1
lines changed

2 files changed

+43
-1
lines changed

doc/contributor/PHP-EXT-options.yml.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ These options are purely for the module generator to decide whether or not to bu
1818
* Required: Yes
1919
* Type: `str`
2020

21-
The lower-case name of the extension as it is shown by `php -m`.
21+
The lower-case name of the extension as it is shown by `php -m` (must match directory name).
2222

2323

2424
### `exclude`

doc/contributor/PHP-TOOL-options.yml.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,45 @@ PHP Tools: `options.yml` |
99

1010

1111
# Tool definition: `options.yml`
12+
13+
These options are purely for the tool generator to decide whether or not to build the tool and in what order to build it (order of dependencies).
14+
15+
16+
### `name`
17+
18+
* Required: Yes
19+
* Type: `str`
20+
21+
The lower-case name of the tool (must match directory name).
22+
23+
24+
### `exclude`
25+
26+
* Required: Yes
27+
* Type: `list[str]`
28+
* Empty: `[]`
29+
30+
Add PHP versions to exclude from building/installing this tool. This could be due to build errors or deprecations.
31+
32+
Example:
33+
```yaml
34+
# Exclude PHP 5.2 and PHP 5.3
35+
exclude: [5.2, 5.3]
36+
```
37+
38+
39+
### `depends`
40+
41+
* Required: Yes
42+
* Type: `list[str]`
43+
* Empty: `[]`
44+
45+
If this tool requires another tool to be present prior building/installing (or just to function properly during run-time), you have to specify them in this list. The tool generator will then ensure to build all available tools in order of dependencies.
46+
47+
Example:
48+
```yaml
49+
# Before installing the current tool, it will be ensured that
50+
# jq is build and installed beforehand.
51+
depends_build:
52+
- jq
53+
```

0 commit comments

Comments
 (0)