Skip to content

Commit e199124

Browse files
committed
Add documentation directory
1 parent f26b491 commit e199124

File tree

6 files changed

+13
-13
lines changed

6 files changed

+13
-13
lines changed
File renamed without changes.
File renamed without changes.
File renamed without changes.

php_modules/README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# PHP Module definitions
22

3-
This documentation describes how to create new or alter existing PHP module definitions.
3+
This document describes how to create new or alter existing PHP module definitions.
44

5-
All PHP modules/extensions (for all PHP versions and both for `amd64` and `arm64` platforms) are defined in here in their dedicated directory. These definitions are then transformed to Ansible group_vars and afterwards Ansible will generate the corresponding Dockerfiles (Stage: `mods`).
5+
All PHP modules/extensions (for all PHP versions and both for `amd64` and `arm64` platforms) are defined in the `php_modules/` directory in their corresponding sub directory. These definitions are then transformed to Ansible group_vars and afterwards Ansible will generate the corresponding Dockerfiles (Stage: `mods`).
66

77

88
## How to add PHP modules?
@@ -11,32 +11,34 @@ All PHP modules/extensions (for all PHP versions and both for `amd64` and `arm64
1111
1. Create a new directory with the name of the PHP module in `php_modules/`
1212
2. Add `build.yml`, `options.yml` and `test.yml` into your newly created directory
1313
3. Alter `build.yml`, `options.yml` and `test.yml` according to documentation below
14-
4. Run `python3 modules-validate.py` to validate the created PHP module definitions
15-
5. Run `python3 modules-generate.py` to create Ansible group_vars
1614

1715
2. **Inside the root of this git repository:**
18-
1. Run `make gen-dockerfiles` to generate Dockerfiles via Ansible
19-
2. Run `make build STAGE=mods VERSION=8.1 ARCH=linux/amd64` to build the `mods` Docker image with version `8.1` for platform `linux/amd64`
16+
1. Run `make gen-modules` to create Ansible group_vars
17+
2. Run `make gen-dockerfiles` to generate Dockerfiles via Ansible
18+
3. Run `make build STAGE=mods VERSION=8.1 ARCH=linux/amd64` to build the `mods` Docker image with version `8.1` for platform `linux/amd64`
2019

2120
**Note:** If you want to test if your new module builds correctly, you can generate Dockerfiles which only contain your module and all others removed. This allows for much faster Docker builds and you don't have to wait for all other modules to be built. To do so you generate group_vars for your module only via:
2221

2322
```bash
23+
# Commands shown here are executed from root of this repository
24+
2425
# Only generate group_vars for curl
25-
# Note: if curl has other modules as requiredments to be built beforehand, those will also be added
26-
python3 module-generate.py curl
26+
# Note: if curl has other modules as requirements to be built beforehand, those will also be added
27+
python3 ./bin/module-generate.py curl
28+
make gen-dockerfiles
2729
```
2830

2931

3032
## Extension definition: `build.yml`
3133

32-
See **[README-build.yml.md](README-build.yml.md)** how to alter the `build.yml` file.
34+
See **[PHP-EXT-build.yml.md](../doc/PHP-EXT-build.yml.md)** how to alter the `build.yml` file.
3335

3436

3537
## Extension definition: `options.yml`
3638

37-
See **[README-options.yml.md](README-options.yml.md)** how to alter the `options.yml` file.
39+
See **[PHP-EXT-options.yml.md](../doc/PHP-EXT-options.yml.md)** how to alter the `options.yml` file.
3840

3941

4042
## Extension definition: `test.yml`
4143

42-
See **[README-test.yml.md](README-test.yml.md)** how to alter the `test.yml` file.
44+
See **[PHP-EXT-test.yml.md](../doc/PHP-EXT-test.yml.md)** how to alter the `test.yml` file.

php_modules/modules-generate.py

Lines changed: 0 additions & 1 deletion
This file was deleted.

php_modules/modules-validate.py

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)