Skip to content

Commit 8e98137

Browse files
committed
Update docs
1 parent bb7ff32 commit 8e98137

File tree

4 files changed

+24
-9
lines changed

4 files changed

+24
-9
lines changed

docs/cmake-modules/FindRE2C.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ re2c_target(
6565
* `<input>` - The re2c template file input. Relative source file path is
6666
interpreted as being relative to the current source directory.
6767
* `<output>` - The output file. Relative output file path is interpreted as
68-
being relative to the current source directory.
68+
being relative to the current binary directory.
6969
* `HEADER` - Generate a <header> file. Relative header file path is interpreted
7070
as being relative to the current binary directory.
7171
* `OPTIONS` - List of additional options to pass to re2c command-line tool.

docs/cmake-modules/PHP/ConfigureFile.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,15 @@ php_configure_file(
2121
)
2222
```
2323

24-
* `VARIABLES`
24+
* `INPUT` or `CONTENT` specify the input template (either a file or a content
25+
string). Relative <template-file> is interpreted as being relative to the
26+
current source directory.
2527

26-
Pairs of variable names and values. Variable values support generator
27-
expressions.
28+
* `OUTPUT` specifies the output file. Relative file path is interpreted as being
29+
relative to the current binary directory.
30+
31+
* `VARIABLES` represent the pairs of variable names and values. Variable values
32+
support generator expressions.
2833

2934
The `$<INSTALL_PREFIX>` generator expression can be used in variable values,
3035
which is replaced with installation prefix either set via the

docs/cmake-modules/PHP/Rebuild.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,12 @@
22

33
See: [Rebuild.cmake](https://github.com/petk/php-build-system/tree/master/cmake/cmake/modules/PHP/Rebuild.cmake)
44

5-
Rebuild all project targets.
5+
Ensure all project targets are rebuilt as needed.
66

7-
When PHP is not found on the system, PHP generates some files during development
8-
using the php_cli target itself, which can bring cyclic dependencies among
9-
targets if custom commands would depend on the php_cli target. Although not a
10-
good practice, this helps bringing all targets to updated state.
7+
When PHP is not found on the system, the `php_cli` target is used to generate
8+
certain files during development. This can lead to cyclic dependencies among
9+
targets if custom commands depend on the `php_cli` target. While such automatic
10+
rebuilding is not considered good practice, it ensures that all targets are kept
11+
up to date.
12+
13+
TODO: This works only for a limited set of cases for now and will be refactored.

docs/cmake-modules/PHP/Stubs.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# PHP/Stubs
2+
3+
See: [Stubs.cmake](https://github.com/petk/php-build-system/tree/master/cmake/cmake/modules/PHP/Stubs.cmake)
4+
5+
Generate *_arginfo.h headers from the *.stub.php sources
6+
7+
The build/gen_stub.php script requires the PHP tokenizer extension.

0 commit comments

Comments
 (0)