Skip to content

Commit fce9e93

Browse files
committed
opal/runtime: fix outdated comment for opal_progress_set_event_flags
The comment for opal_progress_set_event_flags states that default opal_progress_event_flags is OPAL_EVLOOP_ONELOOP, which is not accurate, because OPAL_EVLOOP_ONELOOP has been removed in commit 33c3b71, and was replaced by OPAL_EVLOOP_NONBLOCK | OPAL_EVLOOP_ONCE. This patch fixed the comment about the default argument. It also fixed a typo in the argument section: "vlags" -> "flags" Signed-off-by: Wei Zhang <wzam@amazon.com>
1 parent c1a4c08 commit fce9e93

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

opal/runtime/opal_progress.h

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,11 +66,19 @@ OPAL_DECLSPEC int opal_progress(void);
6666
* Control how the event library is called
6767
*
6868
* Adjust the flags argument used to call opal_event_loop() from
69-
* opal_progress(). The default argument is OPAL_EVLOOP_ONELOOP,
70-
* meaning that the call to opal_event_loop() will block pending
71-
* events, but may block for a period of time.
69+
* opal_progress(). The default argument is
7270
*
73-
* @param flags One of the valid vlags argument to
71+
* OPAL_EVLOOP_NONBLOCK | OPAL_EVLOOP_ONCE
72+
*
73+
* OPAL_EVLOOP_NONBLOCK means that if there is no active events,
74+
* opal_event_loop() should return immediately (instead of
75+
* waiting for active events).
76+
*
77+
* OPAL_EVLOOP_ONCE means opal_event_loop() should onlyrun one
78+
* iteration, which includes poll the event queue and process
79+
* the active events.
80+
*
81+
* @param flags One of the valid flags argument to
7482
* opal_event_loop().
7583
* @return Previous value of flags used to call
7684
* opal_event_loop().

0 commit comments

Comments
 (0)