Fix find_package() modules docs

petk · petk · commit 715823f85763 · 2024-11-14T01:41:20.000+01:00
diff --git a/bin/make-docs.php b/bin/make-docs.php
@@ -26,6 +26,8 @@ function generateModuleDocs(
         return;
     }
 
+    $header = $matches[1];
+
     $moduleName = basename($file, '.cmake');
 
     $content = '';
@@ -39,12 +41,15 @@ function generateModuleDocs(
             include({$namespace}{$moduleName})
             ```
             EOT;
-    } elseif (1 === preg_match('/^Find.+.cmake$/', $moduleName)) {
+    } elseif (1 === preg_match('/^Find(.+)$/', $moduleName, $matches)) {
+        if (isset($matches[1])) {
+            $package = $matches[1];
+        }
         $content .= <<<EOT
             ## Basic usage
 
             ```cmake
-            find_package($moduleName)
+            find_package($package)
             ```
             EOT;
     } else {
@@ -57,7 +62,7 @@ function generateModuleDocs(
             EOT;
     }
     $content .= "\n\n";
-    $content .= $matches[1];
+    $content .= $header;
     $content .= "\n";
 
     if (!file_exists($destination)) {
diff --git a/docs/cmake/modules/FindACL.md b/docs/cmake/modules/FindACL.md
@@ -5,7 +5,7 @@ See: [FindACL.cmake](https://github.com/petk/php-build-system/blob/master/cmake/
 ## Basic usage
 
 ```cmake
-include(cmake/FindACL.cmake)
+find_package(ACL)
 ```
 
 Find the ACL library.
diff --git a/docs/cmake/modules/FindApache.md b/docs/cmake/modules/FindApache.md
@@ -5,7 +5,7 @@ See: [FindApache.cmake](https://github.com/petk/php-build-system/blob/master/cma
 ## Basic usage
 
 ```cmake
-include(cmake/FindApache.cmake)
+find_package(Apache)
 ```
 
 Find the Apache packages and tools.
diff --git a/docs/cmake/modules/FindAppArmor.md b/docs/cmake/modules/FindAppArmor.md
@@ -5,7 +5,7 @@ See: [FindAppArmor.cmake](https://github.com/petk/php-build-system/blob/master/c
 ## Basic usage
 
 ```cmake
-include(cmake/FindAppArmor.cmake)
+find_package(AppArmor)
 ```
 
 Find the AppArmor library.
diff --git a/docs/cmake/modules/FindArgon2.md b/docs/cmake/modules/FindArgon2.md
@@ -5,7 +5,7 @@ See: [FindArgon2.cmake](https://github.com/petk/php-build-system/blob/master/cma
 ## Basic usage
 
 ```cmake
-include(cmake/FindArgon2.cmake)
+find_package(Argon2)
 ```
 
 Find the Argon2 library.
diff --git a/docs/cmake/modules/FindAtomic.md b/docs/cmake/modules/FindAtomic.md
@@ -5,7 +5,7 @@ See: [FindAtomic.cmake](https://github.com/petk/php-build-system/blob/master/cma
 ## Basic usage
 
 ```cmake
-include(cmake/FindAtomic.cmake)
+find_package(Atomic)
 ```
 
 Find the atomic instructions.
diff --git a/docs/cmake/modules/FindBerkeleyDB.md b/docs/cmake/modules/FindBerkeleyDB.md
@@ -5,7 +5,7 @@ See: [FindBerkeleyDB.cmake](https://github.com/petk/php-build-system/blob/master
 ## Basic usage
 
 ```cmake
-include(cmake/FindBerkeleyDB.cmake)
+find_package(BerkeleyDB)
 ```
 
 Find the Berkeley DB library.
diff --git a/docs/cmake/modules/FindCapstone.md b/docs/cmake/modules/FindCapstone.md
@@ -5,7 +5,7 @@ See: [FindCapstone.cmake](https://github.com/petk/php-build-system/blob/master/c
 ## Basic usage
 
 ```cmake
-include(cmake/FindCapstone.cmake)
+find_package(Capstone)
 ```
 
 Find the Capstone library.
diff --git a/docs/cmake/modules/FindCcache.md b/docs/cmake/modules/FindCcache.md
@@ -5,7 +5,7 @@ See: [FindCcache.cmake](https://github.com/petk/php-build-system/blob/master/cma
 ## Basic usage
 
 ```cmake
-include(cmake/FindCcache.cmake)
+find_package(Ccache)
 ```
 
 Find the Ccache compiler cache tool for faster compilation times.
diff --git a/docs/cmake/modules/FindCdb.md b/docs/cmake/modules/FindCdb.md
@@ -5,7 +5,7 @@ See: [FindCdb.cmake](https://github.com/petk/php-build-system/blob/master/cmake/
 ## Basic usage
 
 ```cmake
-include(cmake/FindCdb.cmake)
+find_package(Cdb)
 ```
 
 Find the cdb library.
diff --git a/docs/cmake/modules/FindCrypt.md b/docs/cmake/modules/FindCrypt.md
@@ -5,7 +5,7 @@ See: [FindCrypt.cmake](https://github.com/petk/php-build-system/blob/master/cmak
 ## Basic usage
 
 ```cmake
-include(cmake/FindCrypt.cmake)
+find_package(Crypt)
 ```
 
 Find the crypt library and run a set of PHP-specific checks if library works.
diff --git a/docs/cmake/modules/FindDTrace.md b/docs/cmake/modules/FindDTrace.md
@@ -5,7 +5,7 @@ See: [FindDTrace.cmake](https://github.com/petk/php-build-system/blob/master/cma
 ## Basic usage
 
 ```cmake
-include(cmake/FindDTrace.cmake)
+find_package(DTrace)
 ```
 
 Find DTrace.
diff --git a/docs/cmake/modules/FindDbm.md b/docs/cmake/modules/FindDbm.md
@@ -5,7 +5,7 @@ See: [FindDbm.cmake](https://github.com/petk/php-build-system/blob/master/cmake/
 ## Basic usage
 
 ```cmake
-include(cmake/FindDbm.cmake)
+find_package(Dbm)
 ```
 
 Find the dbm library.
diff --git a/docs/cmake/modules/FindDmalloc.md b/docs/cmake/modules/FindDmalloc.md
@@ -5,7 +5,7 @@ See: [FindDmalloc.cmake](https://github.com/petk/php-build-system/blob/master/cm
 ## Basic usage
 
 ```cmake
-include(cmake/FindDmalloc.cmake)
+find_package(Dmalloc)
 ```
 
 Find the Dmalloc library.
diff --git a/docs/cmake/modules/FindEditline.md b/docs/cmake/modules/FindEditline.md
@@ -5,7 +5,7 @@ See: [FindEditline.cmake](https://github.com/petk/php-build-system/blob/master/c
 ## Basic usage
 
 ```cmake
-include(cmake/FindEditline.cmake)
+find_package(Editline)
 ```
 
 Find the Editline library.
diff --git a/docs/cmake/modules/FindEnchant.md b/docs/cmake/modules/FindEnchant.md
@@ -5,7 +5,7 @@ See: [FindEnchant.cmake](https://github.com/petk/php-build-system/blob/master/cm
 ## Basic usage
 
 ```cmake
-include(cmake/FindEnchant.cmake)
+find_package(Enchant)
 ```
 
 Find the Enchant library.
diff --git a/docs/cmake/modules/FindFFI.md b/docs/cmake/modules/FindFFI.md
@@ -5,7 +5,7 @@ See: [FindFFI.cmake](https://github.com/petk/php-build-system/blob/master/cmake/
 ## Basic usage
 
 ```cmake
-include(cmake/FindFFI.cmake)
+find_package(FFI)
 ```
 
 Find the FFI library.
diff --git a/docs/cmake/modules/FindFirebird.md b/docs/cmake/modules/FindFirebird.md
@@ -5,7 +5,7 @@ See: [FindFirebird.cmake](https://github.com/petk/php-build-system/blob/master/c
 ## Basic usage
 
 ```cmake
-include(cmake/FindFirebird.cmake)
+find_package(Firebird)
 ```
 
 Find the Firebird library.
diff --git a/docs/cmake/modules/FindFreeTDS.md b/docs/cmake/modules/FindFreeTDS.md
@@ -5,7 +5,7 @@ See: [FindFreeTDS.cmake](https://github.com/petk/php-build-system/blob/master/cm
 ## Basic usage
 
 ```cmake
-include(cmake/FindFreeTDS.cmake)
+find_package(FreeTDS)
 ```
 
 Find the FreeTDS set of libraries.
diff --git a/docs/cmake/modules/FindGD.md b/docs/cmake/modules/FindGD.md
@@ -5,7 +5,7 @@ See: [FindGD.cmake](https://github.com/petk/php-build-system/blob/master/cmake/c
 ## Basic usage
 
 ```cmake
-include(cmake/FindGD.cmake)
+find_package(GD)
 ```
 
 Find the GD library.
diff --git a/docs/cmake/modules/FindGDBM.md b/docs/cmake/modules/FindGDBM.md
@@ -5,7 +5,7 @@ See: [FindGDBM.cmake](https://github.com/petk/php-build-system/blob/master/cmake
 ## Basic usage
 
 ```cmake
-include(cmake/FindGDBM.cmake)
+find_package(GDBM)
 ```
 
 Find the GDBM library.
diff --git a/docs/cmake/modules/FindGMP.md b/docs/cmake/modules/FindGMP.md
@@ -5,7 +5,7 @@ See: [FindGMP.cmake](https://github.com/petk/php-build-system/blob/master/cmake/
 ## Basic usage
 
 ```cmake
-include(cmake/FindGMP.cmake)
+find_package(GMP)
 ```
 
 Find the GMP library.
diff --git a/docs/cmake/modules/FindGcov.md b/docs/cmake/modules/FindGcov.md
@@ -5,7 +5,7 @@ See: [FindGcov.cmake](https://github.com/petk/php-build-system/blob/master/cmake
 ## Basic usage
 
 ```cmake
-include(cmake/FindGcov.cmake)
+find_package(Gcov)
 ```
 
 Find the Gcov coverage programs and features.
diff --git a/docs/cmake/modules/FindICU.md b/docs/cmake/modules/FindICU.md
@@ -5,7 +5,7 @@ See: [FindICU.cmake](https://github.com/petk/php-build-system/blob/master/cmake/
 ## Basic usage
 
 ```cmake
-include(cmake/FindICU.cmake)
+find_package(ICU)
 ```
 
 Find the ICU library.
diff --git a/docs/cmake/modules/FindIconv.md b/docs/cmake/modules/FindIconv.md
@@ -5,7 +5,7 @@ See: [FindIconv.cmake](https://github.com/petk/php-build-system/blob/master/cmak
 ## Basic usage
 
 ```cmake
-include(cmake/FindIconv.cmake)
+find_package(Iconv)
 ```
 
 Find the Iconv library.
diff --git a/docs/cmake/modules/FindIntl.md b/docs/cmake/modules/FindIntl.md
@@ -5,7 +5,7 @@ See: [FindIntl.cmake](https://github.com/petk/php-build-system/blob/master/cmake
 ## Basic usage
 
 ```cmake
-include(cmake/FindIntl.cmake)
+find_package(Intl)
 ```
 
 Find the Intl library.
diff --git a/docs/cmake/modules/FindLDAP.md b/docs/cmake/modules/FindLDAP.md
@@ -5,7 +5,7 @@ See: [FindLDAP.cmake](https://github.com/petk/php-build-system/blob/master/cmake
 ## Basic usage
 
 ```cmake
-include(cmake/FindLDAP.cmake)
+find_package(LDAP)
 ```
 
 Find the LDAP library.
diff --git a/docs/cmake/modules/FindLMDB.md b/docs/cmake/modules/FindLMDB.md
@@ -5,7 +5,7 @@ See: [FindLMDB.cmake](https://github.com/petk/php-build-system/blob/master/cmake
 ## Basic usage
 
 ```cmake
-include(cmake/FindLMDB.cmake)
+find_package(LMDB)
 ```
 
 Find the LMDB library.
diff --git a/docs/cmake/modules/FindLibXslt.md b/docs/cmake/modules/FindLibXslt.md
@@ -5,7 +5,7 @@ See: [FindLibXslt.cmake](https://github.com/petk/php-build-system/blob/master/cm
 ## Basic usage
 
 ```cmake
-include(cmake/FindLibXslt.cmake)
+find_package(LibXslt)
 ```
 
 Find the XSLT library (LibXslt).
diff --git a/docs/cmake/modules/FindMC.md b/docs/cmake/modules/FindMC.md
@@ -5,7 +5,7 @@ See: [FindMC.cmake](https://github.com/petk/php-build-system/blob/master/cmake/c
 ## Basic usage
 
 ```cmake
-include(cmake/FindMC.cmake)
+find_package(MC)
 ```
 
 Find Windows compatible message compiler (mc.exe or windmc) command-line tool.
diff --git a/docs/cmake/modules/FindMM.md b/docs/cmake/modules/FindMM.md
@@ -5,7 +5,7 @@ See: [FindMM.cmake](https://github.com/petk/php-build-system/blob/master/cmake/c
 ## Basic usage
 
 ```cmake
-include(cmake/FindMM.cmake)
+find_package(MM)
 ```
 
 Find the mm library.
diff --git a/docs/cmake/modules/FindMySQL.md b/docs/cmake/modules/FindMySQL.md
@@ -5,7 +5,7 @@ See: [FindMySQL.cmake](https://github.com/petk/php-build-system/blob/master/cmak
 ## Basic usage
 
 ```cmake
-include(cmake/FindMySQL.cmake)
+find_package(MySQL)
 ```
 
 Find MySQL-compatible (MySQL, MariaDB, Percona, etc.) database.
diff --git a/docs/cmake/modules/FindNdbm.md b/docs/cmake/modules/FindNdbm.md
@@ -5,7 +5,7 @@ See: [FindNdbm.cmake](https://github.com/petk/php-build-system/blob/master/cmake
 ## Basic usage
 
 ```cmake
-include(cmake/FindNdbm.cmake)
+find_package(Ndbm)
 ```
 
 Find the ndbm library.
diff --git a/docs/cmake/modules/FindNetSnmp.md b/docs/cmake/modules/FindNetSnmp.md
@@ -5,7 +5,7 @@ See: [FindNetSnmp.cmake](https://github.com/petk/php-build-system/blob/master/cm
 ## Basic usage
 
 ```cmake
-include(cmake/FindNetSnmp.cmake)
+find_package(NetSnmp)
 ```
 
 Find the Net-SNMP library.
diff --git a/docs/cmake/modules/FindODBC.md b/docs/cmake/modules/FindODBC.md
@@ -5,7 +5,7 @@ See: [FindODBC.cmake](https://github.com/petk/php-build-system/blob/master/cmake
 ## Basic usage
 
 ```cmake
-include(cmake/FindODBC.cmake)
+find_package(ODBC)
 ```
 
 Find the ODBC library.
diff --git a/docs/cmake/modules/FindOniguruma.md b/docs/cmake/modules/FindOniguruma.md
@@ -5,7 +5,7 @@ See: [FindOniguruma.cmake](https://github.com/petk/php-build-system/blob/master/
 ## Basic usage
 
 ```cmake
-include(cmake/FindOniguruma.cmake)
+find_package(Oniguruma)
 ```
 
 Find the Oniguruma library.
diff --git a/docs/cmake/modules/FindPCRE.md b/docs/cmake/modules/FindPCRE.md
@@ -5,7 +5,7 @@ See: [FindPCRE.cmake](https://github.com/petk/php-build-system/blob/master/cmake
 ## Basic usage
 
 ```cmake
-include(cmake/FindPCRE.cmake)
+find_package(PCRE)
 ```
 
 Find the PCRE library.
diff --git a/docs/cmake/modules/FindPHP.md b/docs/cmake/modules/FindPHP.md
@@ -5,7 +5,7 @@ See: [FindPHP.cmake](https://github.com/petk/php-build-system/blob/master/cmake/
 ## Basic usage
 
 ```cmake
-include(cmake/FindPHP.cmake)
+find_package(PHP)
 ```
 
 Find PHP.
diff --git a/docs/cmake/modules/FindPHPSystem.md b/docs/cmake/modules/FindPHPSystem.md
@@ -5,7 +5,7 @@ See: [FindPHPSystem.cmake](https://github.com/petk/php-build-system/blob/master/
 ## Basic usage
 
 ```cmake
-include(cmake/FindPHPSystem.cmake)
+find_package(PHPSystem)
 ```
 
 Find external PHP on the system, if installed.
diff --git a/docs/cmake/modules/FindQDBM.md b/docs/cmake/modules/FindQDBM.md
@@ -5,7 +5,7 @@ See: [FindQDBM.cmake](https://github.com/petk/php-build-system/blob/master/cmake
 ## Basic usage
 
 ```cmake
-include(cmake/FindQDBM.cmake)
+find_package(QDBM)
 ```
 
 Find the QDBM library.
diff --git a/docs/cmake/modules/FindRE2C.md b/docs/cmake/modules/FindRE2C.md
@@ -5,7 +5,7 @@ See: [FindRE2C.cmake](https://github.com/petk/php-build-system/blob/master/cmake
 ## Basic usage
 
 ```cmake
-include(cmake/FindRE2C.cmake)
+find_package(RE2C)
 ```
 
 Find re2c.
diff --git a/docs/cmake/modules/FindSASL.md b/docs/cmake/modules/FindSASL.md
diff --git a/docs/cmake/modules/FindSELinux.md b/docs/cmake/modules/FindSELinux.md
diff --git a/docs/cmake/modules/FindSendmail.md b/docs/cmake/modules/FindSendmail.md
diff --git a/docs/cmake/modules/FindSodium.md b/docs/cmake/modules/FindSodium.md
diff --git a/docs/cmake/modules/FindSystemd.md b/docs/cmake/modules/FindSystemd.md
diff --git a/docs/cmake/modules/FindTidy.md b/docs/cmake/modules/FindTidy.md
diff --git a/docs/cmake/modules/FindTokyoCabinet.md b/docs/cmake/modules/FindTokyoCabinet.md
diff --git a/docs/cmake/modules/FindValgrind.md b/docs/cmake/modules/FindValgrind.md
diff --git a/docs/cmake/modules/FindWebP.md b/docs/cmake/modules/FindWebP.md
diff --git a/docs/cmake/modules/FindXPM.md b/docs/cmake/modules/FindXPM.md
diff --git a/docs/cmake/modules/Findlibavif.md b/docs/cmake/modules/Findlibavif.md
diff --git a/docs/cmake/modules/Findlibzip.md b/docs/cmake/modules/Findlibzip.md
