Embed PEAR docs into CMakeLists.txt and remove redundant code comments

Author: petk

cmake/ext/com_dotnet/CMakeLists.txt

@@ -28,7 +28,6 @@ project(
   LANGUAGES C
 )
 
-# Available only for Windows system.
 if(NOT CMAKE_SYSTEM_NAME STREQUAL "Windows")
   return()
 endif()

cmake/ext/pcntl/CMakeLists.txt

@@ -4,7 +4,10 @@
 Configure the `pcntl` extension for process control support (CLI/CGI only).
 
 > [!NOTE]
-> This extension is available only for \*nix systems.
+> This extension is available only on \*nix systems.
+
+> [!IMPORTANT]
+> This extension should be used only with cgi, cli, embed, or phpdbg SAPI.
 
 ## EXT_PCNTL
 
@@ -26,7 +29,6 @@ project(
   LANGUAGES C
 )
 
-# Extension is only for *nix systems.
 if(CMAKE_SYSTEM_NAME STREQUAL "Windows")
   return()
 endif()

cmake/ext/posix/CMakeLists.txt

@@ -26,7 +26,6 @@ project(
   LANGUAGES C
 )
 
-# Extension is only for *nix systems.
 if(CMAKE_SYSTEM_NAME STREQUAL "Windows")
   return()
 endif()

cmake/ext/sysvmsg/CMakeLists.txt

@@ -4,7 +4,7 @@
 Configure the `sysvmsg` extension.
 
 > [!NOTE]
-> This extension is available only for \*nix systems.
+> This extension is available only on \*nix systems.
 
 ## EXT_SYSVMSG
 
@@ -26,7 +26,6 @@ project(
   LANGUAGES C
 )
 
-# Extension is only for *nix systems.
 if(CMAKE_SYSTEM_NAME STREQUAL "Windows")
   return()
 endif()

cmake/ext/sysvsem/CMakeLists.txt

@@ -4,7 +4,7 @@
 Configure the `sysvsem` extension.
 
 > [!NOTE]
-> This extension is available only for \*nix systems.
+> This extension is available only on \*nix systems.
 
 ## EXT_SYSVSEM
 
@@ -26,7 +26,6 @@ project(
   LANGUAGES C
 )
 
-# Extension is only for *nix systems.
 if(CMAKE_SYSTEM_NAME STREQUAL "Windows")
   return()
 endif()

cmake/pear/CMakeLists.txt

@@ -1,3 +1,48 @@
+#[=============================================================================[
+# PEAR
+
+Configure PEAR as part of the PHP installation.
+
+> [!WARNING]
+> PEAR installation as part of PHP is deprecated as of PHP 7.4 and will be
+> removed in future PHP versions. PEAR can also be installed manually from the
+> pear.php.net website.
+
+## PHP_PEAR
+
+:orange_circle: *Deprecated as of PHP 7.4.*
+
+* Default: `OFF`
+* Values: `ON|OFF`
+
+Install PEAR, PHP Extension and Application Repository package manager.
+
+## PHP_PEAR_DIR
+
+:orange_circle: *Deprecated as of PHP 7.4.*
+
+* Default: `DATADIR/pear`
+
+The path where PEAR will be installed to. `CMAKE_INSTALL_PREFIX` is
+automatically prepended when given as a relative path.
+
+## PHP_PEAR_TEMP_DIR
+
+:orange_circle: *Deprecated as of PHP 7.4.*
+
+* Default: `tmp/pear` on \*nix and `temp/pear` on Windows
+
+The PEAR temporary directory where PEAR writes temporary files, such as cache,
+downloaded packages artifacts and similar. Pass it as a relative path inside the
+top level system directory, which will be automatically prepended. If given as
+an absolute path, top level directory is not prepended. Relative path is added
+to the top root system directory (`/` on \*nix, or `C:/` on Windows).
+
+For example, default PEAR temporary directory after the top level system
+directory is prepended becomes `/tmp/pear` on \*nix and `C:/temp/pear` on
+Windows.
+#]=============================================================================]
+
 include(FeatureSummary)
 include(PHP/Install)
 include(PHP/Set)
@@ -15,9 +60,7 @@ php_set(
   TYPE PATH
   IF PHP_PEAR
   VALUE "${CMAKE_INSTALL_DATADIR}/pear"
-  DOC
-    "The PEAR installation directory. CMAKE_INSTALL_PREFIX is automatically "
-    "prepended when given as relative path. Default: DATADIR/pear"
+  DOC "The PEAR installation directory."
 )
 mark_as_advanced(PHP_PEAR_DIR)
 
@@ -31,13 +74,7 @@ php_set(
   TYPE PATH
   IF PHP_PEAR
   VALUE "${tmpDir}"
-  DOC
-    "The PEAR temporary directory where PEAR writes temporary files, such as "
-    "cache, downloaded packages artifacts and similar. Pass it as a relative "
-    "path inside the top level system directory, which will be automatically "
-    "prepended. If given as an absolute path, top level directory is not "
-    "prepended. Relative path is added to the top root system directory (/ on "
-    "*nix, or c:/ on Windows). Default: ${tmpDir}."
+  DOC "The PEAR temporary directory. Default: ${tmpDir}."
 )
 mark_as_advanced(PHP_PEAR_TEMP_DIR)
 

cmake/sapi/fpm/CMakeLists.txt

@@ -83,7 +83,6 @@ Where to find systemd installation on the system, can be customized with the
 > system doesn't have systemd.
 #]=============================================================================]
 
-# SAPI is only for *nix systems.
 if(CMAKE_SYSTEM_NAME STREQUAL "Windows")
   return()
 endif()

cmake/sapi/fuzzer/CMakeLists.txt

@@ -3,6 +3,9 @@
 
 Configure the `fuzzer` PHP SAPI.
 
+> [!NOTE]
+> This SAPI is not available when the target system is Windows.
+
 ## SAPI_FUZZER
 
 * Default: `OFF`
@@ -21,7 +24,6 @@ library (e.g. libFuzzer). Can be also environment variable. See
 https://google.github.io/oss-fuzz
 #]=============================================================================]
 
-# SAPI is only for *nix systems.
 if(CMAKE_SYSTEM_NAME STREQUAL "Windows")
   return()
 endif()

cmake/sapi/litespeed/CMakeLists.txt

@@ -14,7 +14,6 @@ Configure the mysqlnd extension.
 Enable the LiteSpeed SAPI module.
 #]=============================================================================]
 
-# SAPI is only for *nix systems.
 if(CMAKE_SYSTEM_NAME STREQUAL "Windows")
   return()
 endif()