Skip to content

Commit 03bfc7f

Browse files
BrandonThomasJonesARMJonathan Watson
authored andcommitted
doc(import_cc): Add initial documentation for attributes
Change-Id: Ia929fdafc8d0e42ea53ffe99be869ef8e0877a3e
1 parent 13d1901 commit 03bfc7f

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

docs/module_types/bob_import_cc.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Module: bob_import_cc
2+
3+
> ⚠ Warning, this target is experimental & the attributes/interface are likely to keep changing. ⚠
4+
5+
```bp
6+
bob_import_cc {
7+
name, src, includes, defines, target, linkopts
8+
}
9+
```
10+
11+
This target exists to include externally built libraries into the linux build graph. This is to better enable a future transition to bazel.
12+
13+
## Properties
14+
15+
| | |
16+
| ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | --- |
17+
| [`name`](properties/common_properties.md#name) | String; required |
18+
| `src` | Optional, path of the built library, leave empty for a header only library. |
19+
| `includes` | List of include dirs needed to link against the external library. |
20+
| `target` | one of either `host` or `target`. Whether the library is built for host or target. |
21+
| `defines` | List of strings; default is `[]`<br>Defines that are included in the local module, and all modules that depend upon it. (Including transitively.) | |
22+
| [`linkopts`](properties/linkopts.md) | List of strings; default is `[]`<br>List of additional flags to the linker command. |

0 commit comments

Comments
 (0)