[ovs-git] [openvswitch/ovs] 3ee7cc: tests: add documentation for OVS_WAIT_UNTIL and OV...

[GitHub]

  Branch: refs/heads/master
  Home:   https://github.com/openvswitch/ovs
  Commit: 3ee7cc6c37c2477295c816fab54d8c6adb8f3003
      https://github.com/openvswitch/ovs/commit/3ee7cc6c37c2477295c816fab54d8c6adb8f3003
  Author: Ansis Atteka <aatteka at nicira.com>
  Date:   2015-11-03 (Tue, 03 Nov 2015)

  Changed paths:
    M tests/ovs-macros.at

  Log Message:
  -----------
  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 at nicira.com>
Signed-off-by: Ansis Atteka <aatteka at nicira.com>