diff mbox

[PATCHv2,3/3] doc: implementers-guide: inactive precond tests

Message ID 1452704893-17874-3-git-send-email-christophe.milard@linaro.org
State Accepted
Commit f4016bd83146b7ecb267d12a03c61ba6ad84b8cf
Headers show

Commit Message

Christophe Milard Jan. 13, 2016, 5:08 p.m. UTC
Signed-off-by: Christophe Milard <christophe.milard@linaro.org>
---
 doc/implementers-guide/implementers-guide.adoc | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
diff mbox

Patch

diff --git a/doc/implementers-guide/implementers-guide.adoc b/doc/implementers-guide/implementers-guide.adoc
index 57be4b2..0eafacf 100644
--- a/doc/implementers-guide/implementers-guide.adoc
+++ b/doc/implementers-guide/implementers-guide.adoc
@@ -418,4 +418,25 @@  test (foo_test_x) is run. If the precondition function (foo_check_x above)
 returns false, the test is not relevant (or impossible to perform) and it will
 be skipped.
 
+=================
+*Note*
+
+Conditionnal tests can be marked as inactive, keeping the precondition
+function. Both the test and the precondition function will be skipped,
+but re-activating the test is then just a matter of changing back the macro
+from ODP_TEST_INFO_INACTIVE to ODP_TEST_INFO_CONDITIONAL:
+
+[source,c]
+------------------
+	...
+	/* active conditionnal test */
+	ODP_TEST_INFO_CONDITIONAL(foo_test_x, foo_check_x),
+
+	/* inactive conditionnal test */
+	ODP_TEST_INFO_INACTIVE(foo_test_y, foo_check_y),
+	...
+------------------
+=================
+
+
 include::../glossary.adoc[]