From a1c17b4b18483915acc7f1d8aa192f12b74fee34 Mon Sep 17 00:00:00 2001 From: Mark <2429165+markseuffert@users.noreply.github.com> Date: Tue, 21 Jun 2022 09:39:42 +0200 Subject: [PATCH 1/2] Updated documentation --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 1e8d073d1..b466fc662 100644 --- a/README.md +++ b/README.md @@ -264,7 +264,7 @@ These tools can be set up globally using the `tools` input. It accepts a string COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }} ``` -- The latest stable version of `composer` is set up by default. You can set up the required `composer` version by specifying the major version `v1` or `v2`, or the version in `major.minor` or `semver` format, Additionally for composer `snapshot` and `preview` can also be specified to set up the respective releases. +- The latest stable version of `composer` is set up by default. You can set up the required `composer` version by specifying the major version `v1` or `v2`, or the version in `major.minor` or `semver` format. Additionally for composer `snapshot` and `preview` can also be specified to set up the respective releases. ```yaml - name: Setup PHP with composer v2 @@ -425,7 +425,7 @@ Disable coverage for these reasons: - Specify the tools you want to set up. - Accepts a `string` in csv-format. For example: `phpunit, phpcs` -- See [tools Support](#wrench-tools-support) for tools supported. +- See [tools support](#wrench-tools-support) for tools supported. ### Outputs @@ -680,12 +680,12 @@ act -P ubuntu-18.04=shivammathur/node:1804 ### JIT Configuration -> Enable Just-in-time(JIT) on PHP 8.0 and above. +> Enable Just-in-time (JIT) on PHP 8.0 and above. - To enable JIT, enable `opcache` in cli mode by setting `opcache.enable_cli=1`. - JIT conflicts with `Xdebug`, `PCOV`, and other extensions which override `zend_execute_ex` function, so set `coverage: none` and disable any such extension if added. - By default, `opcache.jit=1235` and `opcache.jit_buffer_size=256M` are set which can be changed using `ini-values` input. -- For detailed information about JIT related directives refer to the [`official PHP documentation`](https://www.php.net/manual/en/opcache.configuration.php#ini.opcache.jit "opcache.jit documentation"). +- For detailed information about JIT related directives refer to the [official documentation](https://www.php.net/manual/en/opcache.configuration.php#ini.opcache.jit "opcache.jit documentation"). For example to enable JIT in `tracing` mode with buffer size of `64 MB`. @@ -841,7 +841,7 @@ For examples refer to [cs2pr documentation](https://github.com/staabm/annotate-p ### Examples -Examples of using `setup-php` with various PHP Frameworks and Packages. +Examples of using `setup-php` with various PHP frameworks and packages. | Framework/Package | Runs on | Workflow | |----------------------------------------|---------------------------------|---------------------------------------------------------------------------------------------------------------| From 07f2ea7d022fd8ae82fa9ef5cc9fe2b4c030523d Mon Sep 17 00:00:00 2001 From: Mark <2429165+markseuffert@users.noreply.github.com> Date: Tue, 21 Jun 2022 10:04:28 +0200 Subject: [PATCH 2/2] Updated documentation, review --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b466fc662..fc8ec25ec 100644 --- a/README.md +++ b/README.md @@ -685,7 +685,7 @@ act -P ubuntu-18.04=shivammathur/node:1804 - To enable JIT, enable `opcache` in cli mode by setting `opcache.enable_cli=1`. - JIT conflicts with `Xdebug`, `PCOV`, and other extensions which override `zend_execute_ex` function, so set `coverage: none` and disable any such extension if added. - By default, `opcache.jit=1235` and `opcache.jit_buffer_size=256M` are set which can be changed using `ini-values` input. -- For detailed information about JIT related directives refer to the [official documentation](https://www.php.net/manual/en/opcache.configuration.php#ini.opcache.jit "opcache.jit documentation"). +- For detailed information about JIT related directives refer to the [`official PHP documentation`](https://www.php.net/manual/en/opcache.configuration.php#ini.opcache.jit "opcache.jit documentation"). For example to enable JIT in `tracing` mode with buffer size of `64 MB`.