summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPaul Cristian Sarbu <paul.cristian.sarbu@huawei.com>2024-05-13 13:09:08 +0200
committerPaul Cristian Sarbu <paul.cristian.sarbu@huawei.com>2024-05-13 13:09:08 +0200
commit8fadddfa5cd7c3ddc1c595fd952ac74a444187c8 (patch)
treeadc5c893415d82ced1ed40cb8770626188fb6d47 /README.md
parent6c139a965a5020a4bd5f2fde3f19525443a96ac7 (diff)
downloadrules-cc-8fadddfa5cd7c3ddc1c595fd952ac74a444187c8.tar.gz
Update docs
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/README.md b/README.md
index 1fbf4c9..916f6bf 100644
--- a/README.md
+++ b/README.md
@@ -132,6 +132,10 @@ 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). |
+| Config variable | Description |
+| --------------- | ----------- |
+| `"DEBUG"` | Compute the debug-stage, needed for local debugging. |
+
### Rule `["CC", "library"]`
A C++ library
@@ -159,6 +163,10 @@ A C++ library
| `"shared"` | If non-empty, produce a shared instead of a static library. Setting this option is mutually exclusive to the `"object_only"` option. |
| `"object_only"` | If non-empty, produce an object library, resulting in object files added to the linker line of all depending targets. Setting this option is mutually exclusive to the `"shared"` option. |
+| Config variable | Description |
+| --------------- | ----------- |
+| `"DEBUG"` | Compute the debug-stage, needed for local debugging. |
+
### Rule `["CC/prebuilt", "library"]`
A prebuilt C++ library
@@ -192,7 +200,7 @@ A system library via pkg-config
### 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"`.
+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"`. In debug mode, sources needed for local debugging will be installed to subdirectory `"debug-src"`.
| Field | Description |
| ----- | ----------- |