From de7debc179f7345d48d873ac16203d0ac1100b3e Mon Sep 17 00:00:00 2001 From: Lukasz Okraszewski Date: Tue, 10 Oct 2023 08:17:22 +0100 Subject: [PATCH] docs(bob_test): add basic docs Change-Id: Ie19b495e1b083299cce38fe4f99fade7d3db5b17 --- docs/index.md | 1 + docs/module_types/bob_test.md | 28 ++++++++++++++++++++++++++++ 2 files changed, 29 insertions(+) create mode 100644 docs/module_types/bob_test.md diff --git a/docs/index.md b/docs/index.md index 38b223d7..c0cde938 100644 --- 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 new file mode 100644 index 00000000..ee599ff9 --- /dev/null +++ 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 `[]`
Supports glob patterns. | +| `copts` | List of strings; default is `[]`
This options are included as cflags in the compile/link commands. | +| `deps` | List of targets; default is `[]`
The list of other libraries to be linked in to the binary target. | +| [`tags`](properties/common_properties.md#tags) | List of strings; default is `[]` |