Skip to content

Commit 58376ca

Browse files
realFlowControlrealFlowControl
authored
Update docs (#340)
1 parent c40c2c1 commit 58376ca

File tree

7 files changed

+88
-41
lines changed

7 files changed

+88
-41
lines changed

‎.editorconfig‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
indent_style = tab
6+
insert_final_newline = true
7+
trim_trailing_whitespace = true
8+
indent_size = 4
9+
10+
[*.php]
11+
block_comment_start = /*
12+
block_comment = *
13+
block_comment_end = */
14+
15+
[{*Makefile,.gitmodules}]
16+
indent_style = tab

‎CONTRIBUTING.md‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ PHP Versions
1616
- 8.0 (no asan support)
1717
- 8.1
1818
- 8.2
19+
- 8.3
20+
- 8.4
1921

2022
Parallel Services
2123
=================
@@ -47,4 +49,15 @@ Executing:
4749

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

50-
See workflow files for extensive exemplary builds.
52+
Testing (an example)
53+
====================
54+
55+
```sh
56+
docker compose build php-asan-8.4
57+
docker compose build parallel-asan-8.4
58+
docker compose run --rm parallel-asan-8.4
59+
phpize
60+
./configure --enable-parallel
61+
make
62+
./docker/parallel.test --asan
63+
```

‎INSTALL.md‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,25 @@
11
Requirements
22
============
33

4-
* PHP 8.0
4+
* PHP >= 8.0
55
* ZTS
66
* <pthread.h>
77

88
Installation
99
============
1010

11-
**From PECL (recommended)**
11+
**From PECL**
1212

1313
```bash
1414
pecl install parallel
1515
```
1616

17+
**From PIE**
18+
19+
```bash
20+
pie install parallel
21+
```
22+
1723
**Binary distributions**
1824

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

33-
> [!NOTE]
39+
> [!NOTE]
3440
> This will install the latest version from the `develop` branch and should be
3541
> considered unstable!

‎docker-compose.yml‎

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ services:
8787
}
8888
},
8989
container_name: parallel-dbg-8.0,
90-
image: ghcr.io/krakjoe/parallel-dbg-8.0:latest,
90+
image: ghcr.io/krakjoe/parallel-dbg-8.0:8.0.30,
9191
profiles: [parallel-8.0,dbg],
9292
<<: [*dev, *parallel]
9393
}
@@ -103,7 +103,7 @@ services:
103103
}
104104
},
105105
container_name: parallel-gcov-8.0,
106-
image: ghcr.io/krakjoe/parallel-gcov-8.0:latest,
106+
image: ghcr.io/krakjoe/parallel-gcov-8.0:8.0.30,
107107
profiles: [parallel-8.0,gcov],
108108
<<: [*dev, *parallel]
109109
}
@@ -119,7 +119,7 @@ services:
119119
}
120120
},
121121
container_name: parallel-release-8.0,
122-
image: ghcr.io/krakjoe/parallel-release-8.0:latest,
122+
image: ghcr.io/krakjoe/parallel-release-8.0:8.0.30,
123123
profiles: [parallel-8.0,release],
124124
<<: [*dev, *parallel]
125125
}
@@ -135,7 +135,7 @@ services:
135135
}
136136
},
137137
container_name: php-dbg-8.1,
138-
image: ghcr.io/krakjoe/php-dbg-8.1:8.1.28,
138+
image: ghcr.io/krakjoe/php-dbg-8.1:8.1.31,
139139
profiles: [php-8.1,dbg],
140140
<<: [*dev, *parallel]
141141
}
@@ -150,7 +150,7 @@ services:
150150
}
151151
},
152152
container_name: php-gcov-8.1,
153-
image: ghcr.io/krakjoe/php-gcov-8.1:8.1.28,
153+
image: ghcr.io/krakjoe/php-gcov-8.1:8.1.31,
154154
profiles: [php-8.1,gcov],
155155
<<: [*dev, *parallel]
156156
}
@@ -165,7 +165,7 @@ services:
165165
}
166166
},
167167
container_name: php-asan-8.1,
168-
image: ghcr.io/krakjoe/php-asan-8.1:8.1.28,
168+
image: ghcr.io/krakjoe/php-asan-8.1:8.1.31,
169169
profiles: [php-8.1,asan],
170170
<<: [*dev, *parallel]
171171
}
@@ -180,7 +180,7 @@ services:
180180
}
181181
},
182182
container_name: php-release-8.1,
183-
image: ghcr.io/krakjoe/php-release-8.1:8.1.28,
183+
image: ghcr.io/krakjoe/php-release-8.1:8.1.31,
184184
profiles: [php-8.1,release],
185185
<<: [*dev, *parallel]
186186
}
@@ -196,7 +196,7 @@ services:
196196
}
197197
},
198198
container_name: parallel-dbg-8.1,
199-
image: ghcr.io/krakjoe/parallel-dbg-8.1:latest,
199+
image: ghcr.io/krakjoe/parallel-dbg-8.1:8.1.31,
200200
profiles: [parallel-8.1,dbg],
201201
<<: [*dev, *parallel]
202202
}
@@ -212,7 +212,7 @@ services:
212212
}
213213
},
214214
container_name: parallel-gcov-8.1,
215-
image: ghcr.io/krakjoe/parallel-gcov-8.1:latest,
215+
image: ghcr.io/krakjoe/parallel-gcov-8.1:8.1.31,
216216
profiles: [parallel-8.1,gcov],
217217
<<: [*dev, *parallel]
218218
}
@@ -227,7 +227,7 @@ services:
227227
}
228228
},
229229
container_name: parallel-asan-8.1,
230-
image: ghcr.io/krakjoe/parallel-asan-8.1:latest,
230+
image: ghcr.io/krakjoe/parallel-asan-8.1:8.1.31,
231231
profiles: [parallel-8.1,asan],
232232
<<: [*dev, *parallel]
233233
}
@@ -242,7 +242,7 @@ services:
242242
}
243243
},
244244
container_name: parallel-release-8.1,
245-
image: ghcr.io/krakjoe/parallel-release-8.1:latest,
245+
image: ghcr.io/krakjoe/parallel-release-8.1:8.1.31,
246246
profiles: [parallel-8.1,release],
247247
<<: [*dev, *parallel]
248248
}
@@ -259,7 +259,7 @@ services:
259259
}
260260
},
261261
container_name: php-dbg-8.2,
262-
image: ghcr.io/krakjoe/php-dbg-8.2:8.2.19,
262+
image: ghcr.io/krakjoe/php-dbg-8.2:8.2.26,
263263
profiles: [php-8.2,dbg],
264264
<<: [*dev, *parallel]
265265
}
@@ -275,7 +275,7 @@ services:
275275
}
276276
},
277277
container_name: php-gcov-8.2,
278-
image: ghcr.io/krakjoe/php-gcov-8.2:8.2.19,
278+
image: ghcr.io/krakjoe/php-gcov-8.2:8.2.26,
279279
profiles: [php-8.2,gcov],
280280
<<: [*dev, *parallel]
281281
}
@@ -291,7 +291,7 @@ services:
291291
}
292292
},
293293
container_name: php-asan-8.2,
294-
image: ghcr.io/krakjoe/php-asan-8.2:8.2.19,
294+
image: ghcr.io/krakjoe/php-asan-8.2:8.2.26,
295295
profiles: [php-8.2,asan],
296296
<<: [*dev, *parallel]
297297
}
@@ -307,7 +307,7 @@ services:
307307
}
308308
},
309309
container_name: php-release-8.2,
310-
image: ghcr.io/krakjoe/php-release-8.2:8.2.19,
310+
image: ghcr.io/krakjoe/php-release-8.2:8.2.26,
311311
profiles: [php-8.2,release],
312312
<<: [*dev, *parallel]
313313
}
@@ -323,7 +323,7 @@ services:
323323
}
324324
},
325325
container_name: parallel-dbg-8.2,
326-
image: ghcr.io/krakjoe/parallel-dbg-8.2:latest,
326+
image: ghcr.io/krakjoe/parallel-dbg-8.2:8.2.26,
327327
profiles: [parallel-8.2,dbg],
328328
<<: [*dev, *parallel]
329329
}
@@ -339,7 +339,7 @@ services:
339339
}
340340
},
341341
container_name: parallel-gcov-8.2,
342-
image: ghcr.io/krakjoe/parallel-gcov-8.2:latest,
342+
image: ghcr.io/krakjoe/parallel-gcov-8.2:8.2.26,
343343
profiles: [parallel-8.2,gcov],
344344
<<: [*dev, *parallel]
345345
}
@@ -355,7 +355,7 @@ services:
355355
}
356356
},
357357
container_name: parallel-asan-8.2,
358-
image: ghcr.io/krakjoe/parallel-asan-8.2:latest,
358+
image: ghcr.io/krakjoe/parallel-asan-8.2:8.2.26,
359359
profiles: [parallel-8.2,asan],
360360
<<: [*dev, *parallel]
361361
}
@@ -371,7 +371,7 @@ services:
371371
}
372372
},
373373
container_name: parallel-release-8.2,
374-
image: ghcr.io/krakjoe/parallel-release-8.2:latest,
374+
image: ghcr.io/krakjoe/parallel-release-8.2:8.2.26,
375375
profiles: [parallel-8.2,release],
376376
<<: [*dev, *parallel]
377377
}
@@ -388,7 +388,7 @@ services:
388388
}
389389
},
390390
container_name: php-dbg-8.3,
391-
image: parallelphp/php-dbg-8.3:8.3,
391+
image: ghcr.io/krakjoe/parallel-dbg-8.3:8.3.14,
392392
profiles: [php-8.3,dbg],
393393
<<: [*dev, *parallel]
394394
}
@@ -404,7 +404,7 @@ services:
404404
}
405405
},
406406
container_name: php-gcov-8.3,
407-
image: parallelphp/php-gcov-8.3:8.3,
407+
image: ghcr.io/krakjoe/parallel-gcov-8.3:8.3.14,
408408
profiles: [php-8.3,gcov],
409409
<<: [*dev, *parallel]
410410
}
@@ -420,7 +420,7 @@ services:
420420
}
421421
},
422422
container_name: php-asan-8.3,
423-
image: parallelphp/php-asan-8.3:8.3,
423+
image: ghcr.io/krakjoe/php-asan-8.3:8.3.14,
424424
profiles: [php-8.3,asan],
425425
<<: [*dev, *parallel]
426426
}
@@ -436,7 +436,7 @@ services:
436436
}
437437
},
438438
container_name: php-release-8.3,
439-
image: parallelphp/php-release-8.3:8.3,
439+
image: ghcr.io/krakjoe/php-release-8.3:8.3.14,
440440
profiles: [php-8.3,release],
441441
<<: [*dev, *parallel]
442442
}
@@ -452,7 +452,7 @@ services:
452452
}
453453
},
454454
container_name: parallel-dbg-8.3,
455-
image: parallelphp/parallel-dbg-8.3:latest,
455+
image: ghcr.io/krakjoe/parallel-dbg-8.3:8.3.14,
456456
profiles: [parallel-8.3,dbg],
457457
<<: [*dev, *parallel]
458458
}
@@ -468,7 +468,7 @@ services:
468468
}
469469
},
470470
container_name: parallel-gcov-8.3,
471-
image: parallelphp/parallel-gcov-8.3:latest,
471+
image: ghcr.io/krakjoe/parallel-gcov-8.3:8.3.14,
472472
profiles: [parallel-8.3,gcov],
473473
<<: [*dev, *parallel]
474474
}
@@ -484,7 +484,7 @@ services:
484484
}
485485
},
486486
container_name: parallel-asan-8.3,
487-
image: parallelphp/parallel-asan-8.3:latest,
487+
image: ghcr.io/krakjoe/parallel-asan-8.3:8.3.14,
488488
profiles: [parallel-8.3,asan],
489489
<<: [*dev, *parallel]
490490
}
@@ -500,7 +500,7 @@ services:
500500
}
501501
},
502502
container_name: parallel-release-8.3,
503-
image: parallelphp/parallel-release-8.3:latest,
503+
image: ghcr.io/krakjoe/parallel-release-8.3:8.3.14,
504504
profiles: [parallel-8.3,release],
505505
<<: [*dev, *parallel]
506506
}
@@ -517,7 +517,7 @@ services:
517517
}
518518
},
519519
container_name: php-dbg-8.4,
520-
image: parallelphp/php-dbg-8.4:8.4,
520+
image: ghcr.io/krakjoe/php-dbg-8.4:8.4.1,
521521
profiles: [php-8.4,dbg],
522522
<<: [*dev, *parallel]
523523
}
@@ -533,7 +533,7 @@ services:
533533
}
534534
},
535535
container_name: php-gcov-8.4,
536-
image: parallelphp/php-gcov-8.4:8.4,
536+
image: ghcr.io/krakjoe/php-gcov-8.4:8.4.1,
537537
profiles: [php-8.4,gcov],
538538
<<: [*dev, *parallel]
539539
}
@@ -549,7 +549,7 @@ services:
549549
}
550550
},
551551
container_name: php-asan-8.4,
552-
image: parallelphp/php-asan-8.4:8.4,
552+
image: ghcr.io/krakjoe/php-asan-8.4:8.4.1,
553553
profiles: [php-8.4,asan],
554554
<<: [*dev, *parallel]
555555
}
@@ -565,7 +565,7 @@ services:
565565
}
566566
},
567567
container_name: php-release-8.4,
568-
image: parallelphp/php-release-8.4:8.4,
568+
image: ghcr.io/krakjoe/php-release-8.4:8.4.1,
569569
profiles: [php-8.4,release],
570570
<<: [*dev, *parallel]
571571
}
@@ -581,7 +581,7 @@ services:
581581
}
582582
},
583583
container_name: parallel-dbg-8.4,
584-
image: parallelphp/parallel-dbg-8.4:latest,
584+
image: ghcr.io/krakjoe/parallel-dbg-8.4:8.4.1,
585585
profiles: [parallel-8.4,dbg],
586586
<<: [*dev, *parallel]
587587
}
@@ -597,7 +597,7 @@ services:
597597
}
598598
},
599599
container_name: parallel-gcov-8.4,
600-
image: parallelphp/parallel-gcov-8.4:latest,
600+
image: ghcr.io/krakjoe/parallel-gcov-8.4:8.4.1,
601601
profiles: [parallel-8.4,gcov],
602602
<<: [*dev, *parallel]
603603
}
@@ -613,7 +613,7 @@ services:
613613
}
614614
},
615615
container_name: parallel-asan-8.4,
616-
image: parallelphp/parallel-asan-8.4:latest,
616+
image: ghcr.io/krakjoe/parallel-asan-8.4:8.4.1,
617617
profiles: [parallel-8.4,asan],
618618
<<: [*dev, *parallel]
619619
}
@@ -629,7 +629,7 @@ services:
629629
}
630630
},
631631
container_name: parallel-release-8.4,
632-
image: parallelphp/parallel-release-8.4:latest,
632+
image: ghcr.io/krakjoe/parallel-release-8.4:8.4.1,
633633
profiles: [parallel-8.3,release],
634634
<<: [*dev, *parallel]
635635
}

0 commit comments

Comments
 (0)