Skip to content

Commit 66b4c58

Browse files
petkpetk
committed
Update docs
1 parent 6f104da commit 66b4c58

File tree

3 files changed

+137
-97
lines changed

3 files changed

+137
-97
lines changed

‎README.md‎

Lines changed: 93 additions & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -143,99 +143,99 @@ you end up with a large monolithic repository consisting of C source code files,
143143
PHP tests and other associated files:
144144

145145
```sh
146-
<php-src>/
147-
├─ .git/ # Git configuration and source directory
148-
├─ benchmark/ # Benchmark some common applications in CI
149-
├─ build/ # *nix build system files
150-
├─ docs/ # PHP internals documentation
151-
└─ ext/ # PHP core extensions
152-
└─ bcmath/ # The bcmath PHP extension
153-
├─ libbcmath/ # The bcmath library forked and maintained in php-src
154-
├─ tests/ # *.phpt test files for extension
155-
├─ bcmath.stub.php # A stub file for the bcmath extension functions
156-
└─ ...
157-
└─ curl/ # The curl PHP extension
158-
├─ sync-constants.php # The curl symbols checker
159-
└─ ...
160-
└─ date/ # The date/time PHP extension
161-
└─ lib/ # Bundled datetime library https://github.com/derickr/timelib
162-
└─ ...
163-
└─ ...
164-
├─ dl_test/ # Extension for testing dl()
165-
└─ dom/
166-
├─ lexbor/ # https://github.com/lexbor/lexbor
167-
└─ ...
168-
└─ ffi/ # The FFI PHP extension
169-
├─ ffi_parser.c # Generated by https://github.com/dstogov/llk
170-
└─ ...
171-
└─ fileinfo/ # The fileinfo PHP extension
172-
├─ libmagic/ # Modified libmagic https://github.com/file/file
173-
├─ data_file.c # Generated by `ext/fileinfo/create_data_file.php`
174-
├─ libmagic.patch # Modifications patch from upstream libmagic
175-
├─ magicdata.patch # Modifications patch from upstream libmagic
176-
└─ ...
177-
└─ gd/ # The GD PHP extension
178-
├─ libgd/ # Bundled and modified GD library https://github.com/libgd/libgd
179-
└─ ...
180-
└─ mbstring/ # The Multibyte string PHP extension
181-
├─ libmbfl/ # Forked and maintained in php-src
182-
├─ unicode_data.h # Generated by `ext/mbstring/ucgendat/ucgendat.php`
183-
└─ ...
184-
└─ opcache/ # The OPcache PHP extension
185-
└─ jit/ # OPcache Jit
186-
└─ ir/ # Bundled part of IR framework https://github.com/dstogov/ir
187-
└─ dynasm/ # DynASM encoding engine
188-
├─ minilua.c # Customized Lua scripting language to build LuaJIT
189-
└─ ...
190-
├─ gen_ir_fold_hash # IR folding engine generator created at build
191-
├─ ir_emit_<arch>.h # IR folding engine rules generated by minilua
192-
├─ minilua # Executable tool created at build
193-
└─ ...
194-
└─ pcre/ # The PCRE PHP extension
195-
├─ pcre2lib/ # https://www.pcre.org/
196-
└─ ...
197-
├─ skeleton/ # Skeleton for new extensions using `ext/ext_skel.php`
198-
└─ standard/ # Always enabled core extension
199-
└─ html_tables/
200-
├─ mappings/ # https://www.unicode.org/Public/MAPPINGS/
201-
└─ ...
202-
├─ credits_ext.h # Generated by `scripts/dev/credits`
203-
├─ credits_sapi.h # Generated by `scripts/dev/credits`
204-
├─ html_tables.h # Generated by `ext/standard/html_tables/html_table_gen.php`
205-
└─ ...
206-
└─ tokenizer/ # The tokenizer PHP extension
207-
├─ tokenizer_data.c # Generated by `ext/tokenizer/tokenizer_data_gen.php`
208-
├─ tokenizer_data_stub.php # Generated by `ext/tokenizer/tokenizer_data_gen.php`
209-
└─ ...
210-
└─ zend_test # For testing internal APIs. Not needed for regular builds
211-
└─ ...
212-
└─ zip/ # Bundled https://github.com/pierrejoye/php_zip
213-
└─ ...
214-
├─ ...
215-
└─ ext_skel.php # Helper script that creates a new PHP extension
216-
└─ main/ # Binding that ties extensions, SAPIs, Zend engine and TSRM together
217-
├─ streams/ # Streams layer subsystem
218-
└─ ...
219-
├─ modules/ # Shared libraries, created when building PHP
220-
├─ pear/ # PEAR installation
221-
└─ sapi/ # PHP SAPI (Server API) modules
222-
└─ cli/ # Command-line PHP SAPI module
223-
├─ mime_type_map.h # Generated by `sapi/cli/generate_mime_type_map.php`
224-
└─ ...
225-
└─ ...
226-
├─ scripts/ # php-config, phpize and internal development scripts
227-
├─ tests/ # Core features tests
228-
├─ TSRM/ # Thread safe resource manager
229-
└─ Zend/ # Zend engine
230-
├─ asm/ # Bundled from src/asm in https://github.com/boostorg/context
231-
├─ Optimizer/ # For faster PHP execution through opcode caching and optimization
232-
├─ tests/ # PHP tests *.phpt files for Zend engine
233-
├─ zend_vm_execute.h # Generated by `Zend/zend_vm_gen.php`
234-
├─ zend_vm_opcodes.c # Generated by `Zend/zend_vm_gen.php`
235-
├─ zend_vm_opcodes.h # Generated by `Zend/zend_vm_gen.php`
236-
└─ ...
237-
├─ win32/ # Windows build files
238-
└─ ...
146+
🗁 <php-src>
147+
├─🗁 .git # Git configuration and source directory
148+
├─🗁 benchmark # Benchmark some common applications in CI
149+
├─🗁 build # *nix build system files
150+
├─🗁 docs # PHP internals documentation
151+
└─🗁 ext # PHP core extensions
152+
└─🗁 bcmath # The bcmath PHP extension
153+
├─🗁 libbcmath # The bcmath library forked and maintained in php-src
154+
├─🗁 tests # *.phpt test files for extension
155+
├─📄 bcmath.stub.php # A stub file for the bcmath extension functions
156+
└─📄 ...
157+
└─🗁 curl # The curl PHP extension
158+
├─📄 sync-constants.php # The curl symbols checker
159+
└─📄 ...
160+
└─🗁 date # The date/time PHP extension
161+
└─🗁 lib # Bundled datetime library https://github.com/derickr/timelib
162+
└─📄 ...
163+
└─📄 ...
164+
├─🗁 dl_test # Extension for testing dl()
165+
└─🗁 dom
166+
├─🗁 lexbor # https://github.com/lexbor/lexbor
167+
└─📄 ...
168+
└─🗁 ffi # The FFI PHP extension
169+
├─📄 ffi_parser.c # Generated by https://github.com/dstogov/llk
170+
└─📄 ...
171+
└─🗁 fileinfo # The fileinfo PHP extension
172+
├─🗁 libmagic # Modified libmagic https://github.com/file/file
173+
├─📄 data_file.c # Generated by `ext/fileinfo/create_data_file.php`
174+
├─📄 libmagic.patch # Modifications patch from upstream libmagic
175+
├─📄 magicdata.patch # Modifications patch from upstream libmagic
176+
└─📄 ...
177+
└─🗁 gd # The GD PHP extension
178+
├─🗁 libgd # Bundled and modified GD library https://github.com/libgd/libgd
179+
└─📄 ...
180+
└─🗁 mbstring # The Multibyte string PHP extension
181+
├─🗁 libmbfl # Forked and maintained in php-src
182+
├─📄 unicode_data.h # Generated by `ext/mbstring/ucgendat/ucgendat.php`
183+
└─📄 ...
184+
└─🗁 opcache # The OPcache PHP extension
185+
└─🗁 jit # OPcache Jit
186+
└─🗁 ir # Bundled part of IR framework https://github.com/dstogov/ir
187+
└─🗁 dynasm # DynASM encoding engine
188+
├─📄 minilua.c # Customized Lua scripting language to build LuaJIT
189+
└─📄 ...
190+
├─📄 gen_ir_fold_hash # IR folding engine generator created at build
191+
├─📄 ir_emit_<arch>.h # IR folding engine rules generated by minilua
192+
├─📄 minilua # Executable tool created at build
193+
└─📄 ...
194+
└─🗁 pcre # The PCRE PHP extension
195+
├─🗁 pcre2lib # https://www.pcre.org/
196+
└─📄 ...
197+
├─🗁 skeleton # Skeleton for new extensions using `ext/ext_skel.php`
198+
└─🗁 standard # Always enabled core extension
199+
└─🗁 html_tables
200+
├─🗁 mappings # https://www.unicode.org/Public/MAPPINGS/
201+
└─📄 ...
202+
├─📄 credits_ext.h # Generated by `scripts/dev/credits`
203+
├─📄 credits_sapi.h # Generated by `scripts/dev/credits`
204+
├─📄 html_tables.h # Generated by `ext/standard/html_tables/html_table_gen.php`
205+
└─📄 ...
206+
└─🗁 tokenizer # The tokenizer PHP extension
207+
├─📄 tokenizer_data.c # Generated by `ext/tokenizer/tokenizer_data_gen.php`
208+
├─📄 tokenizer_data_stub.php # Generated by `ext/tokenizer/tokenizer_data_gen.php`
209+
└─📄 ...
210+
└─🗁 zend_test # For testing internal APIs. Not needed for regular builds
211+
└─📄 ...
212+
└─🗁 zip/ # Bundled https://github.com/pierrejoye/php_zip
213+
└─📄 ...
214+
├─🗁 ...
215+
└─📄 ext_skel.php # Helper script that creates a new PHP extension
216+
└─🗁 main # Binding that ties extensions, SAPIs, Zend engine and TSRM together
217+
├─🗁 streams # Streams layer subsystem
218+
└─📄 ...
219+
├─🗁 modules # Shared libraries, created when building PHP
220+
├─🗁 pear # PEAR installation
221+
└─🗁 sapi # PHP SAPI (Server API) modules
222+
└─🗁 cli # Command-line PHP SAPI module
223+
├─📄 mime_type_map.h # Generated by `sapi/cli/generate_mime_type_map.php`
224+
└─📄 ...
225+
└─📄 ...
226+
├─🗁 scripts # php-config, phpize and internal development scripts
227+
├─🗁 tests # Core features tests
228+
├─🗁 TSRM # Thread safe resource manager
229+
└─🗁 Zend # Zend engine
230+
├─🗁 asm # Bundled from src/asm in https://github.com/boostorg/context
231+
├─🗁 Optimizer # For faster PHP execution through opcode caching and optimization
232+
├─🗁 tests # PHP tests *.phpt files for Zend engine
233+
├─📄 zend_vm_execute.h # Generated by `Zend/zend_vm_gen.php`
234+
├─📄 zend_vm_opcodes.c # Generated by `Zend/zend_vm_gen.php`
235+
├─📄 zend_vm_opcodes.h # Generated by `Zend/zend_vm_gen.php`
236+
└─📄 ...
237+
├─🗁 win32 # Windows build files
238+
└─📄 ...
239239
```
240240

241241
## Why CMake?

‎docs/differences.md‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,6 @@ build system:
3737
* Better cross-compiling support with CMake toolchain files and ability to set
3838
the cross-compiling emulator.
3939
40-
* The installation include directory (`/usr/local/include/php`) can be adjusted
41-
with `PHP_INCLUDE_PREFIX` variable to support multiple PHP versions. For
42-
example, `/usr/local/include/php/8.4`.
43-
4440
## Behavior
4541
4642
* sapi/phpdbg readline support works more intuitively regardless of the readline
@@ -83,6 +79,16 @@ build system:
8379
* ext/bcmath (Windows: enabled, Autotools: disabled, CMake: disabled)
8480
* ext/calendar (Windows: enabled, Autotools: disabled, CMake: disabled)
8581

82+
* Installation
83+
84+
* The installation include directory (`/usr/local/include/php`) can be
85+
adjusted with the `PHP_INCLUDE_PREFIX` variable to support multiple PHP
86+
versions. For example, `/usr/local/include/php/8.4`.
87+
88+
* The PHP Autotools layout configuration option `--with-layout=[PHP|GNU]` is
89+
in CMake removed and not implemented in favor of the GNU standard directory
90+
layout.
91+
8692
## Bugs fixed
8793

8894
* Building inside folder with spaces.

‎docs/php-installation.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,40 @@ Common practice is to also add program prefix and suffix (for example, to have
173173

174174
See `./configure --help` for more information on how to adjust these locations.
175175

176+
PHP Autotools directory structure with GNU layout:
177+
178+
```sh
179+
🗁 <INSTALL_ROOT> # 🗁
180+
└─🗁 ${prefix} # └─🗁 /usr/local/include
181+
├─🗁 ${bindir} # ├─🗁 bin
182+
└─🗁 ${sysconfdir} # └─🗁 etc
183+
├─🗁 php-fpm.d # ├─🗁 php-fpm.d
184+
├─📄 php-fpm.conf.default # ├─📄 php-fpm.conf.default
185+
└─📄 pear.conf # └─📄 pear.conf
186+
└─🗁 ${includedir} # └─🗁 include
187+
└─🗁 php # └─🗁 php
188+
├─🗁 ext # ├─🗁 ext
189+
├─🗁 main # ├─🗁 main
190+
├─🗁 sapi # ├─🗁 sapi
191+
├─🗁 TSRM # ├─🗁 TSRM
192+
└─🗁 Zend # └─🗁 Zend
193+
└─🗁 ${libdir} # └─🗁 lib
194+
└─🗁 php # └─🗁 php
195+
├─🗁 20230901-zts-debug # ├─🗁 20230901-zts-debug
196+
└─🗁 build # └─🗁 build
197+
├─🗁 ${sbindir} # ├─🗁 sbin
198+
└─🗁 ${datarootdir} # └─🗁 share
199+
└─🗁 ${mandir} # └─🗁 man
200+
├─🗁 man1 # └─🗁 man1
201+
└─🗁 man8 # └─🗁 man8
202+
├─🗁 pear # └─🗁 pear
203+
└─🗁 php # └─🗁 php
204+
└─🗁 fpm # └─🗁 fpm
205+
└─🗁 ${localstatedir} # └─🗁 var
206+
└─🗁 log # └─🗁 log
207+
└─🗁 ${runstatedir} # └─🗁 var/run
208+
```
209+
176210
## Installing PHP with CMake
177211

178212
In this repository, installing PHP with CMake can be done in a similar way:

0 commit comments

Comments
 (0)