The current user and group ID are passed passed to the docker build command and the ownership of the cloned directories are changed to them. This gets rid of git's "dubious ownership" error. Without this changes I got an error: > $ make > docker run --rm -v :/var/www/en -w /var/www -u 1000:1000 php/doc-en > configure.php on PHP 8.2.29, libxml 2.9.14 > > fatal: detected dubious ownership in repository at '/var/www/doc-base' > To add an exception for this directory, call: > > git config --global --add safe.directory /var/www/doc-base > doc-base/temp clean up FAILED. > make: *** [Makefile:22: xhtml] Fehler 1 Resolves: https://github.com/php/doc-en/pull/4645
PHP Documentation
Please refer to the contribution guidelines and the README file within the doc-base repository for details on how to contribute to PHP's documentation.
The PHP manual is available at php.net/docs.
Creating this setup
For information related to creating this setup, see the contribution guidelines or this page on our documentation website.
Building With make and Docker
- Install Docker (https://docs.docker.com/get-docker/)
- Rebuild the documentation using
make - Open output/php-chunked-xhtml/ in your browser.
If the doc-base or phd repositories are available in directories to the
adjacent to this directory, those will be used for building.
To force the Docker image used for building to itself be rebuilt, you can run
make -B build, otherwise the Makefile will only build it if does not
already exist.
You can also build the web version of the documentation with make php
and the output will be placed in output/php-web
Translations
For the translations of this documentation, see:
- Brazilian Portuguese (doc-pt_br)
- Chinese (Simplified) (doc-zh)
- English (doc-en)
- French (doc-fr)
- German (doc-de)
- Italian (doc-it)
- Japanese (doc-ja)
- Polish (doc-pl)
- Romanian (doc-ro)
- Russian (doc-ru)
- Spanish (doc-es)
- Turkish (doc-tr)
- Ukrainian (doc-uk)
Documentation pipeline
For more information on the various repositories that make up PHP's documentation pipeline, see this overview.