From 8ba5e2fd1caa4caddd57286af8a482fb9a90cbbf Mon Sep 17 00:00:00 2001
From: Jeff Hill <johill@lanl.gov>
Date: Tue, 15 Nov 2005 20:22:28 +0000
Subject: [PATCH] clarrified return from ca_poll, ca_pend_event

---
 src/ca/CAref.html | 16 +++++++++-------
 1 file changed, 9 insertions(+), 7 deletions(-)

diff --git a/src/ca/CAref.html b/src/ca/CAref.html
index 231b3be07..64d124c80 100644
--- a/src/ca/CAref.html
+++ b/src/ca/CAref.html
@@ -2957,11 +2957,15 @@ activity is processed for TIMEOUT seconds.</p>
 <p>When ca_poll is invoked the send buffer is flushed and any outstanding CA
 background activity is processed.</p>
 
-<p>This routine will <em>not</em> return before the specified time-out
-expires and all unfinished channel access labor has been processed, and
-unlike <code><a href="#ca_pend_io">ca_pend_io</a></code> it does <em>not
-</em>indicate anything about the status of pending IO requests when it
-returns ECA_NORMAL.</p>
+<p>The ca_pend_event function will <em>not</em> return before the specified
+time-out expires and all unfinished channel access labor has been processed,
+and unlike <code><a href="#ca_pend_io">ca_pend_io</a></code> returning from
+the function does <em>not </em>indicate anything about the status of pending
+IO requests.</p>
+
+<p>Both <code>ca_pend_event</code> and <code>ca_poll</code> return
+ECA_TIMEOUT when successful. This behavior probably isn't intuitive, but it
+is preserved to insure backwards compatibility.</p>
 
 <p>See also <a href="#Thread">Thread Safety and Preemptive Callback to User
 Code</a>.</p>
@@ -2975,8 +2979,6 @@ Code</a>.</p>
 
 <h4>Returns</h4>
 
-<p>ECA_NORMAL - Normal successful completion</p>
-
 <p>ECA_TIMEOUT - The operation timed out</p>
 
 <p>ECA_EVDISALLOW - Function inappropriate for use within a call back