Skip to content

Commit 0e5a751

Browse files
committed
Add usage examples to module docs
1 parent fa7e72b commit 0e5a751

File tree

106 files changed

+669
-21
lines changed

Some content is hidden

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

106 files changed

+669
-21
lines changed

CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ wrapper to bridge the upstream PHP source code with the CMake-based build system
1010
in this repository located at the cmake directory, streamlining the integration
1111
process.
1212
13-
Basic usage:
13+
Usage:
1414
1515
cmake -B <build-dir> [<options>...]
1616

cmake/Zend/cmake/CheckFloatPrecision.cmake

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,13 @@ See: https://wiki.php.net/rfc/rounding
2626
* `HAVE_FPU_INLINE_ASM_X86`
2727
2828
Whether FPU control word can be manipulated by inline assembler.
29+
30+
## Usage
31+
32+
```cmake
33+
# CMakeLists.txt
34+
include(cmake/CheckFloatPrecision.cmake)
35+
```
2936
#]=============================================================================]
3037

3138
include_guard(GLOBAL)

cmake/Zend/cmake/CheckGlobalRegisterVariables.cmake

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,13 @@ See also: [GCC global register variables](https://gcc.gnu.org/onlinedocs/gcc/Glo
1212
* `HAVE_GCC_GLOBAL_REGS`
1313
1414
Whether global register variables are supported.
15+
16+
## Usage
17+
18+
```cmake
19+
# CMakeLists.txt
20+
include(cmake/CheckGlobalRegisterVariables.cmake)
21+
```
1522
#]=============================================================================]
1623

1724
include_guard(GLOBAL)

cmake/Zend/cmake/CheckMMAlignment.cmake

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,13 @@ also does the logarithmic test.
99
* `ZEND_MM_ALIGNMENT`
1010
* `ZEND_MM_ALIGNMENT_LOG2`
1111
* `ZEND_MM_NEED_EIGHT_BYTE_REALIGNMENT`
12+
13+
## Usage
14+
15+
```cmake
16+
# CMakeLists.txt
17+
include(cmake/CheckMMAlignment.cmake)
18+
```
1219
#]=============================================================================]
1320

1421
include_guard(GLOBAL)

cmake/Zend/cmake/CheckStackDirection.cmake

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,13 @@ Check whether the stack grows downwards. Assumes contiguous stack.
88
* `ZEND_CHECK_STACK_LIMIT`
99
1010
Whether checking the stack limit is supported.
11+
12+
## Usage
13+
14+
```cmake
15+
# CMakeLists.txt
16+
include(cmake/CheckStackDirection.cmake)
17+
```
1118
#]=============================================================================]
1219

1320
include_guard(GLOBAL)

cmake/Zend/cmake/CheckStrerrorR.cmake

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,13 @@ version.
1414
1515
Whether `strerror_r()` returns a `char *` message, otherwise it returns an
1616
`int` error number.
17+
18+
## Usage
19+
20+
```cmake
21+
# CMakeLists.txt
22+
include(cmake/CheckStrerrorR.cmake)
23+
```
1724
#]=============================================================================]
1825

1926
include_guard(GLOBAL)

cmake/Zend/cmake/Fibers.cmake

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,13 @@ platform, otherwise it checks if ucontext can be used.
2424
2525
Interface library using Boost fiber assembly files and compile options if
2626
available.
27+
28+
## Usage
29+
30+
```cmake
31+
# CMakeLists.txt
32+
include(cmake/Fibers.cmake)
33+
```
2734
#]=============================================================================]
2835

2936
include_guard(GLOBAL)

cmake/Zend/cmake/MaxExecutionTimers.cmake

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,13 @@ Check whether to enable Zend max execution timers.
2626
2727
Includes possible additional library to be linked for using `timer_create()`
2828
and a compile definition.
29+
30+
## Usage
31+
32+
```cmake
33+
# CMakeLists.txt
34+
include(cmake/MaxExecutionTimers.cmake)
35+
```
2936
#]=============================================================================]
3037

3138
include_guard(GLOBAL)

cmake/cmake/modules/FindACL.cmake

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,13 @@ Module defines the following `IMPORTED` target(s):
2626
* Set `ACL_USE_USER_GROUP` to `TRUE` before calling `find_package(ACL)` to also
2727
check if the ACL library supports `ACL_USER` and `ACL_GROUP`. For example,
2828
macOS doesn't have support for user/group.
29+
30+
## Usage
31+
32+
```cmake
33+
# CMakeLists.txt
34+
find_package(ACL)
35+
```
2936
#]=============================================================================]
3037

3138
include(CheckSourceCompiles)

cmake/cmake/modules/FindApache.cmake

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,13 @@ Module defines the following `IMPORTED` target(s):
3636
* `Apache_INCLUDE_DIR` - Directory containing package library headers.
3737
* `Apache_APR_INCLUDE_DIR` - Directory containing `apr` library headers.
3838
* `Apache_APR_LIBRARY` - The path to the `apr` library.
39+
40+
## Usage
41+
42+
```cmake
43+
# CMakeLists.txt
44+
find_package(Apache)
45+
```
3946
#]=============================================================================]
4047

4148
include(FeatureSummary)

0 commit comments

Comments
 (0)