docs(bob_test): add basic docs

Change-Id: Ie19b495e1b083299cce38fe4f99fade7d3db5b17
ARM-software · Oct 10, 2023 · 186a262 · 186a262
1 parent 5bc677c
commit 186a262
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 0 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -39,3 +39,4 @@
 - [bob_filegroup](module_types/bob_filegroup.md)
 - [bob_genrule](module_types/bob_genrule.md)
 - [bob_gensrcs](module_types/bob_gensrcs.md)
+- [bob_test](module_types/bob_test.md)
diff --git a/docs/module_types/bob_test.md b/docs/module_types/bob_test.md
@@ -0,0 +1,28 @@
+# `bob_test`
+
+> ⚠ Warning, this target is experimental & the attributes/interface are likely to keep changing. ⚠
+
+```bp
+bob_test {
+    name, srcs, hdrs, copts, deps, tags
+}
+```
+
+Indicates a test binary.
+
+On Linux this module behaves like an executable.
+On Android this module generates test targets.
+
+Supports:
+
+- [Gazelle generation](../../gazelle/README.md)
+
+## Properties
+
+|                                                |                                                                                                       |
+| ---------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
+| [`name`](properties/common_properties.md#name) | String; required                                                                                      |
+| [`srcs`](properties/strict_properties.md)      | List of sources; default is `[]`<br>Supports glob patterns.                                           |
+| `copts`                                        | List of strings; default is `[]`<br>This options are included as cflags in the compile/link commands. |
+| `deps`                                         | List of targets; default is `[]`<br>The list of other libraries to be linked in to the binary target. |
+| [`tags`](properties/common_properties.md#tags) | List of strings; default is `[]`                                                                      |