diff options
| -rw-r--r-- | README.md | 11 | ||||
| -rwxr-xr-x | etc/generate-doc.sh | 1 |
2 files changed, 12 insertions, 0 deletions
@@ -14,6 +14,7 @@ A C++ library | `"ldflags"` | Additional linker flags for linking external libraries for this target and its consumers (not built by this tool, typically system libraries). | | `"private-ldflags"` | Additional linker flags for linking external libraries (not built by this tool, typically system libraries). | | `"soversion"` | The SOVERSION for shared libraries. Individual version components are joined with `"."`. | +| `"pkg-name"` | Name to use for pkg-config files. If this field is empty, the field `"name"` is used instead. | | `"srcs"` | The source files of the library. | | `"hdrs"` | Any public header files of the library. | | `"private-hdrs"` | Any header files that only need to be present when compiling the source files, but are not needed for any consumer of the library. | @@ -40,6 +41,16 @@ A binary written in C++ | `"private-deps"` | Any other libraries this binary depends upon. | | `"private-proto"` | Any `["proto", "library"]` this target depends upon directly. The creation of C++ bindings for this proto library as well as of is dependencies will be taken care of (as anonymous targets, so no duplicate work will be carried out, even if the same proto library is used at various places). | +## 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 `"share/pkgconfig"`. + +| Field | Description | +| ----- | ----------- | +| `"flat-libs"` | Install libraries flat to the `"lib"` subdirectory. Be aware that conflicts may occur if any of the (transitive) libraries happen to have the same base name. | +| `"prefix"` | The prefix used for pkg-config files. The path will be made absolute and individual directory components are joined with `"/"`. If no prefix is specified, the value from the config variable `"PREFIX"` is taken, with the default value being `"/"`. | +| `"targets"` | Targets to install artifacts from. | + ## Rule `["CC/test", "test"]` A test written in C++ diff --git a/etc/generate-doc.sh b/etc/generate-doc.sh index ccf379f..fae8907 100755 --- a/etc/generate-doc.sh +++ b/etc/generate-doc.sh @@ -45,6 +45,7 @@ doc2md() { rm -f "$OUTFILE" ( doc2md rules CC library doc2md rules CC binary + doc2md rules CC install-with-deps doc2md rules CC/test test doc2md rules shell/test script doc2md rules proto library |