From 2fb7fdd4f68f921b1a884aa69d3161696051af09 Mon Sep 17 00:00:00 2001
From: Ben Franksen <ben.franksen@online.de>
Date: Wed, 28 Mar 2012 19:33:03 +0000
Subject: [PATCH] docs: added NOEVFLAG constant and its use in pvSync
---
documentation/Reference.txt | 13 ++++++++++++-
1 file changed, 12 insertions(+), 1 deletion(-)
diff --git a/documentation/Reference.txt b/documentation/Reference.txt
index 65b6c65a..e5f9a44f 100644
--- a/documentation/Reference.txt
+++ b/documentation/Reference.txt
@@ -1047,6 +1047,17 @@ boolean
#define FALSE 0
+NOEVFLAG
+^^^^^^^^
+
+::
+
+ #define NOEVFLAG 0
+
+This can be given as second argument to :c:func:`pvSync` (instead of
+an event flag) to cancel the sync.
+
+
.. _BuiltinFunctions:
Built-in Functions
@@ -1339,7 +1350,7 @@ pvSync
void pvSync(assigned_var, event_flag)
Synchronizes a variable with an event flag, or removes such a
-synchronization if ``event_flag`` is zero.
+synchronization if ``event_flag`` is `NOEVFLAG`_.
See :token:`sync` clause.
--
GitLab