diff --git a/NEWS b/NEWS index ecde2eb4..4561d3a4 100644 --- a/NEWS +++ b/NEWS @@ -1,3 +1,11 @@ + +* (Apr 14 2009) Daniel Stenberg: + + libssh2_poll() and libssh2_poll_channel_read() are now considered and + documented deprecated and they will be removed at next soname bump. It also + saves us from fixing some rather quirky bugs in libssh2_poll()... + + Version 1.1 (April 2, 2009) --------------------------- diff --git a/TODO b/TODO index 438b0059..01340b84 100644 --- a/TODO +++ b/TODO @@ -36,3 +36,5 @@ At next SONAME bump libssh2_session_flag() libssh2_channel_handle_extended_data() libssh2_channel_receive_window_adjust() + libssh2_poll() + libssh2_poll_channel_read() diff --git a/docs/libssh2_poll.3 b/docs/libssh2_poll.3 index eb9ae5ae..fed831fe 100644 --- a/docs/libssh2_poll.3 +++ b/docs/libssh2_poll.3 @@ -1,4 +1,4 @@ -.\" $Id: libssh2_poll.3,v 1.3 2007/06/13 12:51:11 jehousley Exp $ +.\" $Id: libssh2_poll.3,v 1.4 2009/04/14 21:38:36 bagder Exp $ .\" .TH libssh2_poll 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual" .SH NAME @@ -8,6 +8,8 @@ libssh2_poll - poll for activity on a socket, channel or listener int libssh2_poll(LIBSSH2_POLLFD *fds, unsigned int nfds, long timeout); .SH DESCRIPTION +This function is deprecated. Do note use. + Poll for activity on a socket, channel, listener, or any combination of these three types. The calling semantics for this function generally match \fIpoll(2)\fP however the structure of fds is somewhat more complex in order diff --git a/docs/libssh2_poll_channel_read.3 b/docs/libssh2_poll_channel_read.3 index 7aa0325f..a8270a7d 100644 --- a/docs/libssh2_poll_channel_read.3 +++ b/docs/libssh2_poll_channel_read.3 @@ -1,4 +1,4 @@ -.\" $Id: libssh2_poll_channel_read.3,v 1.2 2007/06/13 12:51:11 jehousley Exp $ +.\" $Id: libssh2_poll_channel_read.3,v 1.3 2009/04/14 21:38:36 bagder Exp $ .\" .TH libssh2_poll_channel_read 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual" .SH NAME @@ -8,6 +8,8 @@ libssh2_poll_channel_read - check if data is available int libssh2_poll_channel_read(LIBSSH2_CHANNEL *channel, int extended); .SH DESCRIPTION +This function is deprecated. Do note use. + \fIlibssh2_poll_channel_read(3)\fP checks to see if data is available in the \fIchannel\fP's read buffer. No attempt is made with this method to see if packets are available to be processed. For full polling support, use