]> git.ipfire.org Git - thirdparty/gnutls.git/commitdiff
(gnutls_record_recv): Fix docstring, suggested by Tim Kosse
authorSimon Josefsson <simon@josefsson.org>
Thu, 16 Nov 2006 14:10:31 +0000 (14:10 +0000)
committerSimon Josefsson <simon@josefsson.org>
Thu, 16 Nov 2006 14:10:31 +0000 (14:10 +0000)
<tim.kosse@filezilla-project.org>.

lib/gnutls_record.c

index 2c7bc4a1b62846998b0d12fc2208f33349dded17..bb0182819bbb66efb259186f227c5ebbf1b95e5b 100644 (file)
@@ -1133,11 +1133,10 @@ gnutls_record_send (gnutls_session_t session, const void *data,
   * the client's will.
   *
   * If EINTR is returned by the internal push function (the default is
-  * @code{recv()}) then GNUTLS_E_INTERRUPTED will be returned. If
-  * GNUTLS_E_INTERRUPTED or GNUTLS_E_AGAIN is returned, you must call
-  * this function again, with the same parameters; alternatively you
-  * could provide a NULL pointer for data, and 0 for
-  * size. cf. @code{gnutls_record_get_direction()}.
+  * @code{recv()}) then %GNUTLS_E_INTERRUPTED will be returned. If
+  * %GNUTLS_E_INTERRUPTED or %GNUTLS_E_AGAIN is returned, you must
+  * call this function again to get the data.  See also
+  * @code{gnutls_record_get_direction()}.
   *
   * A server may also receive GNUTLS_E_REHANDSHAKE when a client has
   * initiated a handshake. In that case the server can only initiate a