Skip to content

Update docs #340

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 3 commits into from
Mar 14, 2025
Merged

Update docs #340

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b373117
update docs and docker stuff
realFlowControl Mar 14, 2025
2bbf514
add some function docs
realFlowControl Mar 14, 2025
0195196
more
realFlowControl Mar 14, 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
16 changes: 16 additions & 0 deletions .editorconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
root = true

[*]
charset = utf-8
indent_style = tab
insert_final_newline = true
trim_trailing_whitespace = true
indent_size = 4

[*.php]
block_comment_start = /*
block_comment = *
block_comment_end = */

[{*Makefile,.gitmodules}]
indent_style = tab
15 changes: 14 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ PHP Versions
- 8.0 (no asan support)
- 8.1
- 8.2
- 8.3
- 8.4

Parallel Services
=================
Expand Down Expand Up @@ -47,4 +49,15 @@ Executing:

Will execute the test suite with AddressSanitizer support (if enabled in the build).

See workflow files for extensive exemplary builds.
Testing (an example)
====================

```sh
docker compose build php-asan-8.4
docker compose build parallel-asan-8.4
docker compose run --rm parallel-asan-8.4
phpize
./configure --enable-parallel
make
./docker/parallel.test --asan
```
12 changes: 9 additions & 3 deletions INSTALL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,25 @@
Requirements
============

* PHP 8.0
* PHP >= 8.0
* ZTS
* <pthread.h>

Installation
============

**From PECL (recommended)**
**From PECL**

```bash
pecl install parallel
```

**From PIE**

```bash
pie install parallel
```

**Binary distributions**

Microsoft Windows binaries are released through [PECL](https://pecl.php.net/package/parallel).
Expand All @@ -30,6 +36,6 @@ make test
make install
```

> [!NOTE]
> [!NOTE]
> This will install the latest version from the `develop` branch and should be
> considered unstable!
70 changes: 35 additions & 35 deletions docker-compose.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ services:
}
},
container_name: parallel-dbg-8.0,
image: ghcr.io/krakjoe/parallel-dbg-8.0:latest,
image: ghcr.io/krakjoe/parallel-dbg-8.0:8.0.30,
profiles: [parallel-8.0,dbg],
<<: [*dev, *parallel]
}
Expand All @@ -103,7 +103,7 @@ services:
}
},
container_name: parallel-gcov-8.0,
image: ghcr.io/krakjoe/parallel-gcov-8.0:latest,
image: ghcr.io/krakjoe/parallel-gcov-8.0:8.0.30,
profiles: [parallel-8.0,gcov],
<<: [*dev, *parallel]
}
Expand All @@ -119,7 +119,7 @@ services:
}
},
container_name: parallel-release-8.0,
image: ghcr.io/krakjoe/parallel-release-8.0:latest,
image: ghcr.io/krakjoe/parallel-release-8.0:8.0.30,
profiles: [parallel-8.0,release],
<<: [*dev, *parallel]
}
Expand All @@ -135,7 +135,7 @@ services:
}
},
container_name: php-dbg-8.1,
image: ghcr.io/krakjoe/php-dbg-8.1:8.1.28,
image: ghcr.io/krakjoe/php-dbg-8.1:8.1.31,
profiles: [php-8.1,dbg],
<<: [*dev, *parallel]
}
Expand All @@ -150,7 +150,7 @@ services:
}
},
container_name: php-gcov-8.1,
image: ghcr.io/krakjoe/php-gcov-8.1:8.1.28,
image: ghcr.io/krakjoe/php-gcov-8.1:8.1.31,
profiles: [php-8.1,gcov],
<<: [*dev, *parallel]
}
Expand All @@ -165,7 +165,7 @@ services:
}
},
container_name: php-asan-8.1,
image: ghcr.io/krakjoe/php-asan-8.1:8.1.28,
image: ghcr.io/krakjoe/php-asan-8.1:8.1.31,
profiles: [php-8.1,asan],
<<: [*dev, *parallel]
}
Expand All @@ -180,7 +180,7 @@ services:
}
},
container_name: php-release-8.1,
image: ghcr.io/krakjoe/php-release-8.1:8.1.28,
image: ghcr.io/krakjoe/php-release-8.1:8.1.31,
profiles: [php-8.1,release],
<<: [*dev, *parallel]
}
Expand All @@ -196,7 +196,7 @@ services:
}
},
container_name: parallel-dbg-8.1,
image: ghcr.io/krakjoe/parallel-dbg-8.1:latest,
image: ghcr.io/krakjoe/parallel-dbg-8.1:8.1.31,
profiles: [parallel-8.1,dbg],
<<: [*dev, *parallel]
}
Expand All @@ -212,7 +212,7 @@ services:
}
},
container_name: parallel-gcov-8.1,
image: ghcr.io/krakjoe/parallel-gcov-8.1:latest,
image: ghcr.io/krakjoe/parallel-gcov-8.1:8.1.31,
profiles: [parallel-8.1,gcov],
<<: [*dev, *parallel]
}
Expand All @@ -227,7 +227,7 @@ services:
}
},
container_name: parallel-asan-8.1,
image: ghcr.io/krakjoe/parallel-asan-8.1:latest,
image: ghcr.io/krakjoe/parallel-asan-8.1:8.1.31,
profiles: [parallel-8.1,asan],
<<: [*dev, *parallel]
}
Expand All @@ -242,7 +242,7 @@ services:
}
},
container_name: parallel-release-8.1,
image: ghcr.io/krakjoe/parallel-release-8.1:latest,
image: ghcr.io/krakjoe/parallel-release-8.1:8.1.31,
profiles: [parallel-8.1,release],
<<: [*dev, *parallel]
}
Expand All @@ -259,7 +259,7 @@ services:
}
},
container_name: php-dbg-8.2,
image: ghcr.io/krakjoe/php-dbg-8.2:8.2.19,
image: ghcr.io/krakjoe/php-dbg-8.2:8.2.26,
profiles: [php-8.2,dbg],
<<: [*dev, *parallel]
}
Expand All @@ -275,7 +275,7 @@ services:
}
},
container_name: php-gcov-8.2,
image: ghcr.io/krakjoe/php-gcov-8.2:8.2.19,
image: ghcr.io/krakjoe/php-gcov-8.2:8.2.26,
profiles: [php-8.2,gcov],
<<: [*dev, *parallel]
}
Expand All @@ -291,7 +291,7 @@ services:
}
},
container_name: php-asan-8.2,
image: ghcr.io/krakjoe/php-asan-8.2:8.2.19,
image: ghcr.io/krakjoe/php-asan-8.2:8.2.26,
profiles: [php-8.2,asan],
<<: [*dev, *parallel]
}
Expand All @@ -307,7 +307,7 @@ services:
}
},
container_name: php-release-8.2,
image: ghcr.io/krakjoe/php-release-8.2:8.2.19,
image: ghcr.io/krakjoe/php-release-8.2:8.2.26,
profiles: [php-8.2,release],
<<: [*dev, *parallel]
}
Expand All @@ -323,7 +323,7 @@ services:
}
},
container_name: parallel-dbg-8.2,
image: ghcr.io/krakjoe/parallel-dbg-8.2:latest,
image: ghcr.io/krakjoe/parallel-dbg-8.2:8.2.26,
profiles: [parallel-8.2,dbg],
<<: [*dev, *parallel]
}
Expand All @@ -339,7 +339,7 @@ services:
}
},
container_name: parallel-gcov-8.2,
image: ghcr.io/krakjoe/parallel-gcov-8.2:latest,
image: ghcr.io/krakjoe/parallel-gcov-8.2:8.2.26,
profiles: [parallel-8.2,gcov],
<<: [*dev, *parallel]
}
Expand All @@ -355,7 +355,7 @@ services:
}
},
container_name: parallel-asan-8.2,
image: ghcr.io/krakjoe/parallel-asan-8.2:latest,
image: ghcr.io/krakjoe/parallel-asan-8.2:8.2.26,
profiles: [parallel-8.2,asan],
<<: [*dev, *parallel]
}
Expand All @@ -371,7 +371,7 @@ services:
}
},
container_name: parallel-release-8.2,
image: ghcr.io/krakjoe/parallel-release-8.2:latest,
image: ghcr.io/krakjoe/parallel-release-8.2:8.2.26,
profiles: [parallel-8.2,release],
<<: [*dev, *parallel]
}
Expand All @@ -388,7 +388,7 @@ services:
}
},
container_name: php-dbg-8.3,
image: parallelphp/php-dbg-8.3:8.3,
image: ghcr.io/krakjoe/parallel-dbg-8.3:8.3.14,
profiles: [php-8.3,dbg],
<<: [*dev, *parallel]
}
Expand All @@ -404,7 +404,7 @@ services:
}
},
container_name: php-gcov-8.3,
image: parallelphp/php-gcov-8.3:8.3,
image: ghcr.io/krakjoe/parallel-gcov-8.3:8.3.14,
profiles: [php-8.3,gcov],
<<: [*dev, *parallel]
}
Expand All @@ -420,7 +420,7 @@ services:
}
},
container_name: php-asan-8.3,
image: parallelphp/php-asan-8.3:8.3,
image: ghcr.io/krakjoe/php-asan-8.3:8.3.14,
profiles: [php-8.3,asan],
<<: [*dev, *parallel]
}
Expand All @@ -436,7 +436,7 @@ services:
}
},
container_name: php-release-8.3,
image: parallelphp/php-release-8.3:8.3,
image: ghcr.io/krakjoe/php-release-8.3:8.3.14,
profiles: [php-8.3,release],
<<: [*dev, *parallel]
}
Expand All @@ -452,7 +452,7 @@ services:
}
},
container_name: parallel-dbg-8.3,
image: parallelphp/parallel-dbg-8.3:latest,
image: ghcr.io/krakjoe/parallel-dbg-8.3:8.3.14,
profiles: [parallel-8.3,dbg],
<<: [*dev, *parallel]
}
Expand All @@ -468,7 +468,7 @@ services:
}
},
container_name: parallel-gcov-8.3,
image: parallelphp/parallel-gcov-8.3:latest,
image: ghcr.io/krakjoe/parallel-gcov-8.3:8.3.14,
profiles: [parallel-8.3,gcov],
<<: [*dev, *parallel]
}
Expand All @@ -484,7 +484,7 @@ services:
}
},
container_name: parallel-asan-8.3,
image: parallelphp/parallel-asan-8.3:latest,
image: ghcr.io/krakjoe/parallel-asan-8.3:8.3.14,
profiles: [parallel-8.3,asan],
<<: [*dev, *parallel]
}
Expand All @@ -500,7 +500,7 @@ services:
}
},
container_name: parallel-release-8.3,
image: parallelphp/parallel-release-8.3:latest,
image: ghcr.io/krakjoe/parallel-release-8.3:8.3.14,
profiles: [parallel-8.3,release],
<<: [*dev, *parallel]
}
Expand All @@ -517,7 +517,7 @@ services:
}
},
container_name: php-dbg-8.4,
image: parallelphp/php-dbg-8.4:8.4,
image: ghcr.io/krakjoe/php-dbg-8.4:8.4.1,
profiles: [php-8.4,dbg],
<<: [*dev, *parallel]
}
Expand All @@ -533,7 +533,7 @@ services:
}
},
container_name: php-gcov-8.4,
image: parallelphp/php-gcov-8.4:8.4,
image: ghcr.io/krakjoe/php-gcov-8.4:8.4.1,
profiles: [php-8.4,gcov],
<<: [*dev, *parallel]
}
Expand All @@ -549,7 +549,7 @@ services:
}
},
container_name: php-asan-8.4,
image: parallelphp/php-asan-8.4:8.4,
image: ghcr.io/krakjoe/php-asan-8.4:8.4.1,
profiles: [php-8.4,asan],
<<: [*dev, *parallel]
}
Expand All @@ -565,7 +565,7 @@ services:
}
},
container_name: php-release-8.4,
image: parallelphp/php-release-8.4:8.4,
image: ghcr.io/krakjoe/php-release-8.4:8.4.1,
profiles: [php-8.4,release],
<<: [*dev, *parallel]
}
Expand All @@ -581,7 +581,7 @@ services:
}
},
container_name: parallel-dbg-8.4,
image: parallelphp/parallel-dbg-8.4:latest,
image: ghcr.io/krakjoe/parallel-dbg-8.4:8.4.1,
profiles: [parallel-8.4,dbg],
<<: [*dev, *parallel]
}
Expand All @@ -597,7 +597,7 @@ services:
}
},
container_name: parallel-gcov-8.4,
image: parallelphp/parallel-gcov-8.4:latest,
image: ghcr.io/krakjoe/parallel-gcov-8.4:8.4.1,
profiles: [parallel-8.4,gcov],
<<: [*dev, *parallel]
}
Expand All @@ -613,7 +613,7 @@ services:
}
},
container_name: parallel-asan-8.4,
image: parallelphp/parallel-asan-8.4:latest,
image: ghcr.io/krakjoe/parallel-asan-8.4:8.4.1,
profiles: [parallel-8.4,asan],
<<: [*dev, *parallel]
}
Expand All @@ -629,7 +629,7 @@ services:
}
},
container_name: parallel-release-8.4,
image: parallelphp/parallel-release-8.4:latest,
image: ghcr.io/krakjoe/parallel-release-8.4:8.4.1,
profiles: [parallel-8.3,release],
<<: [*dev, *parallel]
}
Loading
Loading