]> xenbits.xensource.com Git - people/pauldu/xenbus.git/commitdiff
Fix comment in evtchn_interface.h
authorPaul Durrant <paul.durrant@citrix.com>
Thu, 1 Nov 2018 17:59:21 +0000 (17:59 +0000)
committerPaul Durrant <paul.durrant@citrix.com>
Thu, 1 Nov 2018 18:00:45 +0000 (18:00 +0000)
The comment about the return value of the Unmask method is incorrent. It
will return TRUE if the operation did not complete.

Signed-off-by: Paul Durrant <paul.durrant@citrix.com>
include/evtchn_interface.h

index 068a69734fe985a782b2626a6094cc565bb9b6e2..ade725902421af1f7f9b61f24d8b1c4a6269f235 100644 (file)
@@ -141,7 +141,7 @@ typedef VOID
     \param Interface The interface header
     \param Channel The channel handle
     \param InCallback Set to TRUE if this method is invoked in context of the channel callback
-    \param Force Set to TRUE if the unmask must succeed, otherwise set to FALSE and the function will return FALSE if the unmask did not complete.
+    \param Force Set to TRUE if the unmask must succeed, otherwise set to FALSE and the function will return TRUE if the unmask did not complete and there is still an event pending.
 */
 typedef BOOLEAN
 (*XENBUS_EVTCHN_UNMASK)(