Mark extensions deprecated and minor docs improvement

SimonFrings · SimonFrings · commit 181941f80641 · 2021-07-08T10:27:12.000+02:00
diff --git a/README.md b/README.md
@@ -21,8 +21,8 @@ single [`run()`](#run) call that is controlled by the user.
     * [Loop implementations](#loop-implementations)
         * [StreamSelectLoop](#streamselectloop)
         * [ExtEventLoop](#exteventloop)
-        * [ExtLibeventLoop](#extlibeventloop)
-        * [ExtLibevLoop](#extlibevloop)
+        * [~~ExtLibeventLoop~~](#extlibeventloop)
+        * [~~ExtLibevLoop~~](#extlibevloop)
         * [ExtEvLoop](#extevloop)
         * [ExtUvLoop](#extuvloop)
     * [LoopInterface](#loopinterface)
@@ -362,34 +362,41 @@ See also [`addTimer()`](#addtimer) for more details.
 
 An `ext-event` based event loop.
 
-This uses the [`event` PECL extension](https://pecl.php.net/package/event).
-It supports the same backends as libevent.
+This uses the [`event` PECL extension](https://pecl.php.net/package/event),
+that provides an interface to `libevent` library.
+`libevent` itself supports a number of system-specific backends (epoll, kqueue).
 
 This loop is known to work with PHP 5.4 through PHP 7+.
 
 #### ExtEvLoop
 
 An `ext-ev` based event loop.
 
-This loop uses the [`ev` PECL extension](https://pecl.php.net/package/ev), that
-provides an interface to `libev` library.
+This loop uses the [`ev` PECL extension](https://pecl.php.net/package/ev),
+that provides an interface to `libev` library.
+`libev` itself supports a number of system-specific backends (epoll, kqueue).
+
 
 This loop is known to work with PHP 5.4 through PHP 7+.
 
 #### ExtUvLoop
 
 An `ext-uv` based event loop.
 
-This loop uses the [`uv` PECL extension](https://pecl.php.net/package/uv), that
-provides an interface to `libuv` library.
+This loop uses the [`uv` PECL extension](https://pecl.php.net/package/uv),
+that provides an interface to `libuv` library.
+`libuv` itself supports a number of system-specific backends (epoll, kqueue).
 
 This loop is known to work with PHP 7+.
 
-#### ExtLibeventLoop
+#### ~~ExtLibeventLoop~~
+
+> Deprecated since v1.2.0, use [`ExtEventLoop`](#exteventloop) instead.
 
 An `ext-libevent` based event loop.
 
-This uses the [`libevent` PECL extension](https://pecl.php.net/package/libevent).
+This uses the [`libevent` PECL extension](https://pecl.php.net/package/libevent),
+that provides an interface to `libevent` library.
 `libevent` itself supports a number of system-specific backends (epoll, kqueue).
 
 This event loop does only work with PHP 5.
@@ -408,12 +415,15 @@ As such, it's recommended to use `stream_set_read_buffer($stream, 0);`
 to disable PHP's internal read buffer in this case.
 See also [`addReadStream()`](#addreadstream) for more details.
 
-#### ExtLibevLoop
+#### ~~ExtLibevLoop~~
+
+> Deprecated since v1.2.0, use [`ExtEvLoop`](#extevloop) instead.
 
 An `ext-libev` based event loop.
 
-This uses an [unofficial `libev` extension](https://github.com/m4rw3r/php-libev).
-It supports the same backends as libevent.
+This uses an [unofficial `libev` extension](https://github.com/m4rw3r/php-libev),
+that provides an interface to `libev` library.
+`libev` itself supports a number of system-specific backends (epoll, kqueue).
 
 This loop does only work with PHP 5.
 An update for PHP 7 is [unlikely](https://github.com/m4rw3r/php-libev/issues/8)
diff --git a/src/ExtEvLoop.php b/src/ExtEvLoop.php
@@ -14,6 +14,7 @@
  *
  * This loop uses the [`ev` PECL extension](https://pecl.php.net/package/ev),
  * that provides an interface to `libev` library.
+ * `libev` itself supports a number of system-specific backends (epoll, kqueue).
  *
  * This loop is known to work with PHP 5.4 through PHP 7+.
  *
diff --git a/src/ExtEventLoop.php b/src/ExtEventLoop.php
@@ -12,8 +12,9 @@
 /**
  * An `ext-event` based event loop.
  *
- * This uses the [`event` PECL extension](https://pecl.php.net/package/event).
- * It supports the same backends as libevent.
+ * This uses the [`event` PECL extension](https://pecl.php.net/package/event),
+ * that provides an interface to `libevent` library.
+ * `libevent` itself supports a number of system-specific backends (epoll, kqueue).
  *
  * This loop is known to work with PHP 5.4 through PHP 7+.
  *
diff --git a/src/ExtLibevLoop.php b/src/ExtLibevLoop.php
@@ -12,17 +12,19 @@
 use SplObjectStorage;
 
 /**
- * An `ext-libev` based event loop.
+ * [Deprecated] An `ext-libev` based event loop.
  *
- * This uses an [unofficial `libev` extension](https://github.com/m4rw3r/php-libev).
- * It supports the same backends as libevent.
+ * This uses an [unofficial `libev` extension](https://github.com/m4rw3r/php-libev),
+ * that provides an interface to `libev` library.
+ * `libev` itself supports a number of system-specific backends (epoll, kqueue).
  *
  * This loop does only work with PHP 5.
  * An update for PHP 7 is [unlikely](https://github.com/m4rw3r/php-libev/issues/8)
  * to happen any time soon.
  *
  * @see https://github.com/m4rw3r/php-libev
  * @see https://gist.github.com/1688204
+ * @deprecated 1.2.0, use [`ExtEvLoop`](#extevloop) instead.
  */
 final class ExtLibevLoop implements LoopInterface
 {
diff --git a/src/ExtLibeventLoop.php b/src/ExtLibeventLoop.php
@@ -10,9 +10,10 @@
 use SplObjectStorage;
 
 /**
- * An `ext-libevent` based event loop.
+ * [Deprecated] An `ext-libevent` based event loop.
  *
- * This uses the [`libevent` PECL extension](https://pecl.php.net/package/libevent).
+ * This uses the [`libevent` PECL extension](https://pecl.php.net/package/libevent),
+ * that provides an interface to `libevent` library.
  * `libevent` itself supports a number of system-specific backends (epoll, kqueue).
  *
  * This event loop does only work with PHP 5.
@@ -32,6 +33,7 @@
  * See also [`addReadStream()`](#addreadstream) for more details.
  *
  * @link https://pecl.php.net/package/libevent
+ * @deprecated 1.2.0, use [`ExtEventLoop`](#exteventloop) instead.
  */
 final class ExtLibeventLoop implements LoopInterface
 {
diff --git a/src/ExtUvLoop.php b/src/ExtUvLoop.php
@@ -11,6 +11,7 @@
  *
  * This loop uses the [`uv` PECL extension](https://pecl.php.net/package/uv),
  * that provides an interface to `libuv` library.
+ * `libuv` itself supports a number of system-specific backends (epoll, kqueue).
  *
  * This loop is known to work with PHP 7+.
  *

Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@`
`14`	`14`	`*`
`15`	`15`	* This loop uses the [`ev` PECL extension](https://pecl.php.net/package/ev),
`16`	`16`	* that provides an interface to `libev` library.
	`17`	+ * `libev` itself supports a number of system-specific backends (epoll, kqueue).
`17`	`18`	`*`
`18`	`19`	`* This loop is known to work with PHP 5.4 through PHP 7+.`
`19`	`20`	`*`
Original file line number	Diff line number	Diff line change
`@@ -12,8 +12,9 @@`
`12`	`12`	`/**`
`13`	`13`	* An `ext-event` based event loop.
`14`	`14`	`*`
`15`		- * This uses the [`event` PECL extension](https://pecl.php.net/package/event).
`16`		`- * It supports the same backends as libevent.`
	`15`	+ * This uses the [`event` PECL extension](https://pecl.php.net/package/event),
	`16`	+ * that provides an interface to `libevent` library.
	`17`	+ * `libevent` itself supports a number of system-specific backends (epoll, kqueue).
`17`	`18`	`*`
`18`	`19`	`* This loop is known to work with PHP 5.4 through PHP 7+.`
`19`	`20`	`*`
Original file line number	Diff line number	Diff line change
`@@ -12,17 +12,19 @@`
`12`	`12`	`use SplObjectStorage;`
`13`	`13`
`14`	`14`	`/**`
`15`		- * An `ext-libev` based event loop.
	`15`	+ * [Deprecated] An `ext-libev` based event loop.
`16`	`16`	`*`
`17`		- * This uses an [unofficial `libev` extension](https://github.com/m4rw3r/php-libev).
`18`		`- * It supports the same backends as libevent.`
	`17`	+ * This uses an [unofficial `libev` extension](https://github.com/m4rw3r/php-libev),
	`18`	+ * that provides an interface to `libev` library.
	`19`	+ * `libev` itself supports a number of system-specific backends (epoll, kqueue).
`19`	`20`	`*`
`20`	`21`	`* This loop does only work with PHP 5.`
`21`	`22`	`* An update for PHP 7 is [unlikely](https://github.com/m4rw3r/php-libev/issues/8)`
`22`	`23`	`* to happen any time soon.`
`23`	`24`	`*`
`24`	`25`	`* @see https://github.com/m4rw3r/php-libev`
`25`	`26`	`* @see https://gist.github.com/1688204`
	`27`	+ * @deprecated 1.2.0, use [`ExtEvLoop`](#extevloop) instead.
`26`	`28`	`*/`
`27`	`29`	`final class ExtLibevLoop implements LoopInterface`
`28`	`30`	`{`
Original file line number	Diff line number	Diff line change
`@@ -10,9 +10,10 @@`
`10`	`10`	`use SplObjectStorage;`
`11`	`11`
`12`	`12`	`/**`
`13`		- * An `ext-libevent` based event loop.
	`13`	+ * [Deprecated] An `ext-libevent` based event loop.
`14`	`14`	`*`
`15`		- * This uses the [`libevent` PECL extension](https://pecl.php.net/package/libevent).
	`15`	+ * This uses the [`libevent` PECL extension](https://pecl.php.net/package/libevent),
	`16`	+ * that provides an interface to `libevent` library.
`16`	`17`	* `libevent` itself supports a number of system-specific backends (epoll, kqueue).
`17`	`18`	`*`
`18`	`19`	`* This event loop does only work with PHP 5.`
`@@ -32,6 +33,7 @@`
`32`	`33`	* See also [`addReadStream()`](#addreadstream) for more details.
`33`	`34`	`*`
`34`	`35`	`* @link https://pecl.php.net/package/libevent`
	`36`	+ * @deprecated 1.2.0, use [`ExtEventLoop`](#exteventloop) instead.
`35`	`37`	`*/`
`36`	`38`	`final class ExtLibeventLoop implements LoopInterface`
`37`	`39`	`{`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@`
`11`	`11`	`*`
`12`	`12`	* This loop uses the [`uv` PECL extension](https://pecl.php.net/package/uv),
`13`	`13`	* that provides an interface to `libuv` library.
	`14`	+ * `libuv` itself supports a number of system-specific backends (epoll, kqueue).
`14`	`15`	`*`
`15`	`16`	`* This loop is known to work with PHP 7+.`
`16`	`17`	`*`