Skip to content

Commit

Permalink
[DOCS] Change text in docs for phive
Browse files Browse the repository at this point in the history
Fixes: #543, #429
  • Loading branch information
kanow committed Feb 3, 2025
1 parent ba5095a commit 16050ee
Showing 1 changed file with 13 additions and 9 deletions.
22 changes: 13 additions & 9 deletions Documentation/DependencyManager.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,12 @@
Dependency manager
==================

To keep things simple, most development tools, for example PHP_CodeSniffer, are
installed by Composer as development requirements and in some cases where
installation via Composer is not possible, we use `PHIVE <https://phar.io/>`__.
To keep things simple, we try do model as many dependencies as possible as
Composer dependencies in the composer.json`. However, sometime a dependency
is not available for all PHP versions that we support, or it might conflict
with another dependency.

PHIVE packages each tool with all its dependencies as
`PHIVE <https://phar.io/>`__ manage each tool with all its dependencies as
a separate PHAR. This helps avoid dependency hell (which means that you cannot
install or upgrade some tool as the tool's dependencies conflict with the
dependencies on another library). It also allows running versions of tools
Expand All @@ -22,12 +23,15 @@ for this project.
Using PHIVE to install `phpunit/phpcov`
=======================================

To support php version 7.4 and 8.2 in the `tea` extension, we are using PHIVE
to install `phpunit/phpcov`.
We need `phpunit/phpcov` in version 10 to support php 8.2.
Our minimum php version 7.4 would prevent the installation with composer.
One of this cases is PHPCOV, a library we use to
collect and transmit code coverage information: The version that works with
PHP 8.2 and 8.3 does not work with PHP 7.3. So we have to switch this particular
dependency from being installed via Composer to being installed via
PHIVE.
With the usage of PHIVE we can support a wider range of PHP versions in the tea
extension.

.. note::

To find more information about install and usage,
please check out the documentation of `PHIVE <https://phar.io>`__.
please check out the documentation of `PHIVE <https://phar.io#Usage>`__.

0 comments on commit 16050ee

Please sign in to comment.