Skip to content

Commit f8dbf0e

Browse files
committed
Update README for clearer explanation
1 parent 91a1e0f commit f8dbf0e

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,13 @@ To build and run unit tests for a specific library:
6363
task test-<lib_name>
6464
```
6565

66+
The default behaviors for ystdlib-cpp unit test building are:
67+
* As a top-level project, unit tests are built.
68+
* When included as a subproject, the parent-scope `BUILD_TESTING` flag (true /false/undefined) is
69+
strictly respected.
70+
If you do not wish to build unit tests under any circumstances, you can override the default
71+
behaviors by setting CMake option `YSTDLIB_CPP_BUILD_TESTING` to `OFF`.
72+
6673
As a top-level CMake project, `ystdlib-cpp` always builds unit tests. When included as a subproject,
6774
it respects the parent-scope `BUILD_TESTING` flag. In either case, you can turn off unit test
6875
building by setting option `YSTDLIB_CPP_BUILD_TESTING` to off.

0 commit comments

Comments
 (0)