tests: add documentation for OVS_WAIT_UNTIL and OVS_WAIT_WHILE macros
authorAnsis Atteka <aatteka@nicira.com>
Tue, 3 Nov 2015 23:29:32 +0000 (15:29 -0800)
committerAnsis Atteka <aatteka@nicira.com>
Wed, 4 Nov 2015 00:22:01 +0000 (16:22 -0800)
commit3ee7cc6c37c2477295c816fab54d8c6adb8f3003
tree40a603e6e8e471902fd839ca33237f390dc68559
parent23508e797bc21d1f08e5ca30a69cd4e14bc2cf05
tests: add documentation for OVS_WAIT_UNTIL and OVS_WAIT_WHILE macros

It is very easy to misuse these macros, because when the COMMAND
returns exit code "0" it is actually considered as if condition
evaluated to "true" and not "false" as some might think.

This patch ensures that this is clearly reflected in documentation.

Acked-by: Ben Pfaff <blp@nicira.com>
Signed-off-by: Ansis Atteka <aatteka@nicira.com>
tests/ovs-macros.at