com php-src: correct readme [ci skip]: README.md
| From: | Joe Watkins | Date: | Sun, 31 Mar 2019 07:43:53 +0000 |
| Subject: | com php-src: correct readme [ci skip]: README.md | ||
| Groups: | php.cvs | ||
| Request: | Send a blank email to php-cvs+get-105423@lists.php.net to get a copy of this message | ||
Commit: 79c6636f15d6d7334ff75a2e73090b9454121a15
Author: Joe Watkins <krakjoe@php.net> Sun, 31 Mar 2019 09:43:53 +0200
Parents: ba2269ab9e88e6acc4f3626527ed5ccd24f02872
Branches: PHP-7.4 master
Link: http://git.php.net/?p=php-src.git;a=commitdiff;h=79c6636f15d6d7334ff75a2e73090b9454121a15
Log:
correct readme [ci skip]
Changed paths:
M README.md
Diff:
diff --git a/README.md b/README.md
index 09dde4f..e59a262 100644
--- a/README.md
+++ b/README.md
@@ -33,23 +33,46 @@ For Windows, the PHP binaries can be obtained from
For other systems, see the [installation chapter](https://php.net/install).
-### Building PHP from source
+### Building PHP source code
-On \*nix systems:
+*For Windows, see [Build your own PHP on
Windows](https://wiki.php.net/internals/windows/stepbystepbuild_sdk_2).*
+
+PHP uses autotools on Unix systems to configure the build:
./buildconf
- ./configure
- make
- make test
+ ./configure [options]
+
+*See
./configure -h for configuration options.*
+
+ make [options]
+
+*See make -h for make options.*
+
+The -j option shall set the maximum number of jobs make can use for the
build:
+
+ make -j4
+
+Shall run make with a maximum of 4 concurrent jobs: Generally the maximum number of
jobs should not exceed the number of cores available.
+
+## Testing PHP source code
+
+PHP ships with an extensive test suite, the command make test is used after successful
compilation of the sources to run this test suite.
-See ./configure -h and make -h for configuration options. For example,
the
--j option allows parallel execution of the build recipes where N is the
-number of available processor cores:
+It is possible to run tests using multiple cores by setting -jN in
PHP_TEST_ARGS:
- make -j N
+ make PHP_TEST_ARGS=-j4 test
+
+Shall run make test with a maximum of 4 concurrent jobs: Generally the maximum number
of jobs should not exceed the number of cores available.
-For Windows, see
-[Build your own PHP on Windows](https://wiki.php.net/internals/windows/stepbystepbuild_sdk_2).
+The [qa.php.net](https://qa.php.net) site provides more detailed info about testing and quality
assurance.
+
+## Installing PHP built from source
+
+After a successful build (and test), PHP may be installed with:
+
+ make install
+
+Depending on your permissions and prefix, make install may need super user
permissions.
## PHP extensions
@@ -97,17 +120,6 @@ contribute:
- [Mailinglist rules](/docs/mailinglist-rules.md)
- [PHP release process](/docs/release-process.md)
-## Testing
-
-To run tests the make test is used after a successful compilation of the
-sources. The -j option provides faster parallel execution based on the number
-of cores (N):
-
- make -j N test
-
-The [qa.php.net](https://qa.php.net) site provides more detailed info about
-testing and quality assurance.
-
## Credits
For the list of people who've put work into PHP, please see the