Skip to content

Commit 4d55ba8

Browse files
petkpetk
committed
Add initial docs for project-specific modules
1 parent 6bdb612 commit 4d55ba8

File tree

97 files changed

+2563
-59
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

97 files changed

+2563
-59
lines changed

‎docs/cmake-modules/FindACL.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# FindACL
2+
3+
Find the ACL library.
4+
5+
Module defines the following IMPORTED target(s):
6+
7+
ACL::ACL
8+
The package library, if found.
9+
10+
Result variables:
11+
12+
ACL_FOUND
13+
Whether the package has been found.
14+
ACL_INCLUDE_DIRS
15+
Include directories needed to use this package.
16+
ACL_LIBRARIES
17+
Libraries needed to link to the package library.
18+
ACL_VERSION
19+
Package version, if found.
20+
21+
Cache variables:
22+
23+
ACL_IS_BUILT_IN
24+
Whether ACL is a part of the C library (BSD-based systems).
25+
ACL_INCLUDE_DIR
26+
Directory containing package library headers.
27+
ACL_LIBRARY
28+
The path to the package library.
29+
30+
Hints:
31+
32+
The ACL_ROOT variable adds custom search path.
33+
34+
Set ACL_USE_USER_GROUP to TRUE before calling find_package(ACL) to also check
35+
if the ACL library supports ACL_USER and ACL_GROUP. For example, macOS doesn't
36+
have support for user/group.

‎docs/cmake-modules/FindApache.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# FindApache
2+
3+
Find the Apache packages and tools.
4+
5+
The Apache development package usually contains Apache header files, the apr
6+
(Apache Portable Runtime) library and its headers, apr config command-line tool,
7+
and the apxs command-line tool.
8+
9+
Module defines the following IMPORTED target(s):
10+
11+
Apache::Apache
12+
The package library, if found.
13+
14+
Result variables:
15+
16+
Apache_FOUND
17+
Whether the package has been found.
18+
Apache_INCLUDE_DIRS
19+
Include directories needed to use this package.
20+
Apache_LIBRARIES
21+
Libraries needed to link to the package library.
22+
Apache_VERSION
23+
Package version, if found.
24+
Apache_THREADED
25+
Whether Apache requires thread safety.
26+
Apache_LIBEXECDIR
27+
Path to the directory containing all Apache modules and httpd.exp file (list
28+
of exported symbols).
29+
30+
Cache variables:
31+
32+
Apache_APXS_EXECUTABLE
33+
Path to the APache eXtenSion tool command-line tool.
34+
Apache_APXS_DEFINITIONS
35+
A list of compile definitions (-D) from the apxs CFLAGS query string.
36+
Apache_APR_CONFIG_EXECUTABLE
37+
Path to the apr library command-line configuration tool.
38+
Apache_APR_CPPFLAGS
39+
A list of C preprocessor flags for the APR library.
40+
Apache_APU_CONFIG_EXECUTABLE
41+
Path to the Apache Portable Runtime Utilities config command-line tool.
42+
Apache_EXECUTABLE
43+
Path to the Apache command-line server program.
44+
Apache_INCLUDE_DIR
45+
Directory containing package library headers.
46+
Apache_APR_INCLUDE_DIR
47+
Directory containing apr library headers.
48+
Apache_APR_LIBRARY
49+
The path to the apr library.
50+
51+
Hints:
52+
53+
The Apache_ROOT variable adds custom search path.

‎docs/cmake-modules/FindAppArmor.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# FindAppArmor
2+
3+
Find the AppArmor library.
4+
5+
Module defines the following IMPORTED target(s):
6+
7+
AppArmor::AppArmor
8+
The package library, if found.
9+
10+
Result variables:
11+
12+
AppArmor_FOUND
13+
Whether the package has been found.
14+
AppArmor_INCLUDE_DIRS
15+
Include directories needed to use this package.
16+
AppArmor_LIBRARIES
17+
Libraries needed to link to the package library.
18+
AppArmor_VERSION
19+
Package version, if found.
20+
21+
Cache variables:
22+
23+
AppArmor_INCLUDE_DIR
24+
Directory containing package library headers.
25+
AppArmor_LIBRARY
26+
The path to the package library.
27+
28+
Hints:
29+
30+
The AppArmor_ROOT variable adds custom search path.

‎docs/cmake-modules/FindArgon2.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# FindArgon2
2+
3+
Find the Argon2 library.
4+
5+
Module defines the following IMPORTED target(s):
6+
7+
Argon2::Argon2
8+
The package library, if found.
9+
10+
Result variables:
11+
12+
Argon2_FOUND
13+
Whether the package has been found.
14+
Argon2_INCLUDE_DIRS
15+
Include directories needed to use this package.
16+
Argon2_LIBRARIES
17+
Libraries needed to link to the package library.
18+
Argon2_VERSION
19+
Package version, if found.
20+
21+
Cache variables:
22+
23+
Argon2_INCLUDE_DIR
24+
Directory containing package library headers.
25+
Argon2_LIBRARY
26+
The path to the package library.
27+
28+
Hints:
29+
30+
The Argon2_ROOT variable adds custom search path.

‎docs/cmake-modules/FindAtomic.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# FindAtomic
2+
3+
Find the atomic instructions.
4+
5+
Module defines the following IMPORTED target(s):
6+
7+
Atomic::Atomic
8+
The Atomic library, if found.
9+
10+
Result variables:
11+
12+
Atomic_FOUND
13+
Whether atomic instructions are available.
14+
Atomic_LIBRARIES
15+
A list of libraries needed in order to use atomic functionality.

‎docs/cmake-modules/FindBerkeleyDB.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# FindBerkeleyDB
2+
3+
Find the Berkeley DB library.
4+
5+
Module defines the following IMPORTED target(s):
6+
7+
BerkeleyDB::BerkeleyDB
8+
The package library, if found.
9+
10+
Result variables:
11+
12+
BerkeleyDB_FOUND
13+
Whether the package has been found.
14+
BerkeleyDB_INCLUDE_DIRS
15+
Include directories needed to use this package.
16+
BerkeleyDB_LIBRARIES
17+
Libraries needed to link to the package library.
18+
19+
Cache variables:
20+
21+
BerkeleyDB_INCLUDE_DIR
22+
Directory containing package library headers.
23+
BerkeleyDB_LIBRARY
24+
The path to the package library.
25+
BerkeleyDB_DB1_INCLUDE_DIR
26+
Directory containing headers for DB1 emulation support in Berkeley DB.
27+
28+
Hints:
29+
30+
The BerkeleyDB_ROOT variable adds custom search path.
31+
32+
Set BerkeleyDB_USE_DB1 to TRUE before calling find_package(BerkeleyDB) to
33+
enable the Berkeley DB 1.x support/emulation.

‎docs/cmake-modules/FindCapstone.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# FindCapstone
2+
3+
Find the Capstone library.
4+
5+
Module defines the following IMPORTED target(s):
6+
7+
Capstone::Capstone
8+
The package library, if found.
9+
10+
Result variables:
11+
12+
Capstone_FOUND
13+
Whether the package has been found.
14+
Capstone_INCLUDE_DIRS
15+
Include directories needed to use this package.
16+
Capstone_LIBRARIES
17+
Libraries needed to link to the package library.
18+
Capstone_VERSION
19+
Package version, if found.
20+
21+
Cache variables:
22+
23+
Capstone_INCLUDE_DIR
24+
Directory containing package library headers.
25+
Capstone_LIBRARY
26+
The path to the package library.
27+
28+
Hints:
29+
30+
The Capstone_ROOT variable adds custom search path.

‎docs/cmake-modules/FindCcache.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# FindCcache
2+
3+
Find the Ccache compiler cache tool for faster compilation times.
4+
5+
Result variables:
6+
7+
Ccache_FOUND
8+
Whether the package has been found.
9+
Ccache_VERSION
10+
Package version, if found.
11+
12+
Cache variables:
13+
14+
Ccache_EXECUTABLE
15+
The path to the ccache executable.
16+
17+
Hints:
18+
19+
The Ccache_ROOT variable adds custom search path.
20+
21+
CCACHE_DISABLE environment variable disables the ccache and doesn't add it to
22+
C and CXX launcher, see Ccache documentation for more info.

‎docs/cmake-modules/FindCdb.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# FindCdb
2+
3+
Find the cdb library.
4+
5+
Module defines the following IMPORTED target(s):
6+
7+
Cdb::Cdb
8+
The package library, if found.
9+
10+
Result variables:
11+
12+
Cdb_FOUND
13+
Whether the package has been found.
14+
Cdb_INCLUDE_DIRS
15+
Include directories needed to use this package.
16+
Cdb_LIBRARIES
17+
Libraries needed to link to the package library.
18+
Cdb_VERSION
19+
Package version, if found.
20+
21+
Cache variables:
22+
23+
Cdb_INCLUDE_DIR
24+
Directory containing package library headers.
25+
Cdb_LIBRARY
26+
The path to the package library.
27+
28+
Hints:
29+
30+
The Cdb_ROOT variable adds custom search path.

‎docs/cmake-modules/FindCrypt.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# FindCrypt
2+
3+
Find the crypt library and run a set of PHP-specific checks if library works.
4+
5+
The Crypt library can be on some systems part of the standard C library. The
6+
crypt() and crypt_r() functions are usually declared in the unistd.h or crypt.h.
7+
The GNU C library removed the crypt library in version 2.39 and replaced it with
8+
the libxcrypt, at the time of writing, located at
9+
https://github.com/besser82/libxcrypt.
10+
11+
Module defines the following IMPORTED target(s):
12+
13+
Crypt::Crypt
14+
The package library, if found.
15+
16+
Result variables:
17+
18+
Crypt_FOUND
19+
Whether the package has been found.
20+
Crypt_INCLUDE_DIRS
21+
Include directories needed to use this package.
22+
Crypt_LIBRARIES
23+
Libraries needed to link to the package library.
24+
Crypt_VERSION
25+
Package version, if found.
26+
27+
Cache variables:
28+
29+
Crypt_IS_BUILT_IN
30+
Whether crypt is a part of the C library.
31+
Crypt_INCLUDE_DIR
32+
Directory containing package library headers.
33+
Crypt_LIBRARY
34+
The path to the package library.
35+
36+
Hints:
37+
The Crypt_ROOT variable adds custom search path.

0 commit comments

Comments
 (0)