diff options
| author | Oliver Reiche <oliver.reiche@huawei.com> | 2023-08-18 18:45:32 +0200 |
|---|---|---|
| committer | Oliver Reiche <oliver.reiche@huawei.com> | 2023-08-22 14:50:35 +0200 |
| commit | 307c96681e6626286804c45273082dff94127878 (patch) | |
| tree | a7186dce6766d4904cb76a880432d909fe722370 | |
| parent | 4df77c2cfc163e6ec2ae8a3512e633496cf7de28 (diff) | |
| download | rules-cc-307c96681e6626286804c45273082dff94127878.tar.gz | |
Update documentation
| -rw-r--r-- | README.md | 14 | ||||
| -rwxr-xr-x | etc/generate-doc.sh | 1 |
2 files changed, 15 insertions, 0 deletions
@@ -113,6 +113,20 @@ A prebuilt C++ library | `"deps"` | Any other libraries this library depends upon. | | `"pkg-config"` | Pkg-config file for optional infer of public cflags and ldflags. If multiple files are specified (e.g., one depends on the other), the first one is used as entry. Note that if this field is non-empty the tool `"pkg-config"` must be available in `"PATH"`, which is taken from `["CC", "defaults"]` or the `"ENV"` variable. | +### Rule `["CC/pkgconfig", "system_library"]` + +A system library via pkg-config + +| Field | Description | +| ----- | ----------- | +| `"name"` | The pkg-config name of the library. | +| `"args"` | Additional pkg-config arguments (e.g., `"--define-prefix"` or `"--static"`), appended to the config variable `"PKG_CONFIG_ARGS"`. | +| `"stage"` | The stage of the internally created flag files. | + +| Config variable | Description | +| --------------- | ----------- | +| `"PKG_CONFIG_ARGS"` | Additional pkg-config arguments (e.g., `"--define-prefix"` or `"--static"`). | + ### Rule `["CC", "install-with-deps"]` Install target's artifacts with transitive dependencies. Depending on the target, artifacts and dependencies will be installed to subdirectories `"bin"`, `"include"`, and `"lib"`. For library targets, a pkg-config file is generated and provided in `"lib/pkgconfig"`. diff --git a/etc/generate-doc.sh b/etc/generate-doc.sh index c6e0caa..47a83bd 100755 --- a/etc/generate-doc.sh +++ b/etc/generate-doc.sh @@ -57,6 +57,7 @@ rm -f "$OUTFILE" doc2md rules CC binary doc2md rules CC library doc2md rules CC/prebuilt library + doc2md rules CC/pkgconfig system_library doc2md rules CC install-with-deps doc2md rules CC/test test doc2md rules CC defaults |