Skip to content

Commit 967a5b0

Browse files
petkpetk
committed
Add documentation for extensions and SAPIs
Documentation is much easier handled if it's simply bundled into CMake files directly. This adds Markdown-based documentation for extensions and SAPIs similar to other files.
1 parent 9ea3198 commit 967a5b0

File tree

31 files changed

+1097
-1
lines changed

31 files changed

+1097
-1
lines changed

‎cmake/ext/bcmath/CMakeLists.txt‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
1+
#[=============================================================================[
2+
# The bcmath extension
3+
4+
Configure the `bcmath` extension.
5+
6+
## EXT_BCMATH
7+
8+
* Default: `OFF`
9+
* Values: `ON|OFF`
10+
11+
Enable the extension.
12+
13+
## EXT_BCMATH_SHARED
14+
15+
* Default: `OFF`
16+
* Values: `ON|OFF`
17+
18+
Build extension as shared.
19+
#]=============================================================================]
20+
121
project(
222
PhpExtensionBcMath
323
LANGUAGES C

‎cmake/ext/bz2/CMakeLists.txt‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
1+
#[=============================================================================[
2+
# The bz2 extension
3+
4+
Configure the `bz2` extension.
5+
6+
## EXT_BZ2
7+
8+
* Default: `OFF`
9+
* Values: `ON|OFF`
10+
11+
Enable the extension.
12+
13+
## EXT_BZ2_SHARED
14+
15+
* Default: `OFF`
16+
* Values: `ON|OFF`
17+
18+
Build extension as shared.
19+
#]=============================================================================]
20+
121
project(
222
PhpExtensionBz2
323
LANGUAGES C

‎cmake/ext/calendar/CMakeLists.txt‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
1+
#[=============================================================================[
2+
# The calendar extension
3+
4+
Configure the `calendar` extension.
5+
6+
## EXT_CALENDAR
7+
8+
* Default: `OFF`
9+
* Values: `ON|OFF`
10+
11+
Enable the extension.
12+
13+
## EXT_CALENDAR_SHARED
14+
15+
* Default: `OFF`
16+
* Values: `ON|OFF`
17+
18+
Build extension as shared.
19+
#]=============================================================================]
20+
121
project(
222
PhpExtensionCalendar
323
LANGUAGES C

‎cmake/ext/com_dotnet/CMakeLists.txt‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,26 @@
1+
#[=============================================================================[
2+
# The com_dotnet extension
3+
4+
Configure the `com_dotnet` extension.
5+
6+
> [!NOTE]
7+
> This extension is available only when the target system is Windows.
8+
9+
## EXT_COM_DOTNET
10+
11+
* Default: `ON`
12+
* Values: `ON|OFF`
13+
14+
Enable the extension.
15+
16+
## EXT_COM_DOTNET_SHARED
17+
18+
* Default: `OFF`
19+
* Values: `ON|OFF`
20+
21+
Build extension as shared.
22+
#]=============================================================================]
23+
124
project(
225
PhpExtensionBz2
326
LANGUAGES C

‎cmake/ext/ctype/CMakeLists.txt‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
1+
#[=============================================================================[
2+
# The ctype extension
3+
4+
Configure the `ctype` extension.
5+
6+
## EXT_CTYPE
7+
8+
* Default: `ON`
9+
* Values: `ON|OFF`
10+
11+
Enable the extension.
12+
13+
## EXT_CTYPE_SHARED
14+
15+
* Default: `OFF`
16+
* Values: `ON|OFF`
17+
18+
Build extension as shared.
19+
#]=============================================================================]
20+
121
project(
222
PhpExtensionCtype
323
LANGUAGES C

‎cmake/ext/curl/CMakeLists.txt‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
1+
#[=============================================================================[
2+
# The curl extension
3+
4+
Configure the `curl` extension.
5+
6+
## EXT_CURL
7+
8+
* Default: `OFF`
9+
* Values: `ON|OFF`
10+
11+
Enable the extension.
12+
13+
## EXT_CURL_SHARED
14+
15+
* Default: `OFF`
16+
* Values: `ON|OFF`
17+
18+
Build extension as shared.
19+
#]=============================================================================]
20+
121
project(
222
PhpExtensionCurl
323
LANGUAGES C

‎cmake/ext/date/CMakeLists.txt‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
#[=============================================================================[
2+
# The date extension
3+
4+
Configure the `date` extension.
5+
6+
This extension is always enabled and cannot be built as shared.
7+
#]=============================================================================]
8+
19
project(
210
PhpExtensionDate
311
LANGUAGES C

‎cmake/ext/dba/CMakeLists.txt‎

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,114 @@
1+
#[=============================================================================[
2+
# The dba extension
3+
4+
Configure the `dba` extension.
5+
6+
## EXT_DBA
7+
8+
* Default: `OFF`
9+
* Values: `ON|OFF`
10+
11+
Enable the PHP `dba` extension.
12+
13+
## EXT_DBA_SHARED
14+
15+
* Default: `OFF`
16+
* Values: `ON|OFF`
17+
18+
Build extension as shared library.
19+
20+
## EXT_DBA_CDB
21+
22+
* Default: `ON`
23+
* Values: `ON|OFF`
24+
25+
Enable the bundled constant databases (cdb) support.
26+
27+
## EXT_DBA_CDB_EXTERNAL
28+
29+
* Default: `OFF`
30+
* Values: `ON|OFF`
31+
32+
Use external (system) cdb library instead of the bundled sources.
33+
34+
> [!WARNING]
35+
> At the time of writing external cdb library installed on \*nix systems is most
36+
> likely tinycdb, which isn't supported by PHP. Recommendation is to not enable
37+
> this option and use the bundled cdb library that comes with PHP sources.
38+
39+
## EXT_DBA_DB
40+
41+
* Default: `OFF`
42+
* Values: `ON|OFF`
43+
44+
Enable the Oracle Berkeley DB support.
45+
46+
## EXT_DBA_DB1
47+
48+
* Default: `OFF`
49+
* Values: `ON|OFF`
50+
51+
Enable the Oracle Berkeley DB 1.x support/emulation.
52+
53+
## EXT_DBA_DBM
54+
55+
* Default: `OFF`
56+
* Values: `ON|OFF`
57+
58+
Enable the legacy (original) Berkeley DB style support.
59+
60+
## EXT_DBA_FLATFILE
61+
62+
* Default: `ON`
63+
* Values: `ON|OFF`
64+
65+
Enable the bundled flat-file DBA handler support.
66+
67+
## EXT_DBA_GDBM
68+
69+
:red_circle: *Removed as of PHP 8.4.*
70+
71+
* Default: `OFF`
72+
* Values: `ON|OFF`
73+
74+
Enable the GNU dbm (GDBM) support.
75+
76+
## EXT_DBA_INIFILE
77+
78+
* Default: `ON`
79+
* Values: `ON|OFF`
80+
81+
Enable the bundled INI-file DBA handler support.
82+
83+
## EXT_DBA_LMDB
84+
85+
* Default: `OFF`
86+
* Values: `ON|OFF`
87+
88+
Enable the Lightning Memory-Mapped Database (LMDB) support.
89+
90+
## EXT_DBA_NDBM
91+
92+
* Default: `OFF`
93+
* Values: `ON|OFF`
94+
95+
Enable the ndbm support.
96+
97+
## EXT_DBA_QDBM
98+
99+
* Default: `OFF`
100+
* Values: `ON|OFF`
101+
102+
Enable the QDBM support.
103+
104+
## EXT_DBA_TCADB
105+
106+
* Default: `OFF`
107+
* Values: `ON|OFF`
108+
109+
Enable the Tokyo Cabinet abstract DB support.
110+
#]=============================================================================]
111+
1112
project(
2113
PhpExtensionDba
3114
LANGUAGES C

‎cmake/ext/dl_test/CMakeLists.txt‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
#[=============================================================================[
2+
# The dl_test extension
3+
4+
Configure the `dl_test` extension.
5+
6+
## EXT_DL_TEST
7+
8+
* Default: `OFF`
9+
* Values: `ON|OFF`
10+
11+
Enable the extension.
12+
13+
This extension is always built as shared when enabled.
14+
#]=============================================================================]
15+
116
project(
217
PhpExtensionDlTest
318
LANGUAGES C

‎cmake/ext/dom/CMakeLists.txt‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
1+
#[=============================================================================[
2+
# The dom extension
3+
4+
Configure the `dom` extension.
5+
6+
## EXT_DOM
7+
8+
* Default: `ON`
9+
* Values: `ON|OFF`
10+
11+
Enable the extension.
12+
13+
## EXT_DOM_SHARED
14+
15+
* Default: `OFF`
16+
* Values: `ON|OFF`
17+
18+
Build extension as shared.
19+
#]=============================================================================]
20+
121
project(
222
PhpExtensionDom
323
LANGUAGES C

0 commit comments

Comments
 (0)