Better explanation of ftdi_read_data() behaviour

On the mailing list, some have come to the conclusion that the 0.17 and 1.0
behaviour of ftdi_read_data() is the most sensible, but needs mor
explanation.

Hopefully the added explanation fullfills this target.
--
Uwe Bonnes                bon@elektron.ikp.physik.tu-darmstadt.de

Institut fuer Kernphysik  Schlossgartenstrasse 9  64289 Darmstadt
--------- Tel. 06151 162516 -------- Fax. 06151 164321 ----------
>From eec274ebd929611180b3524c66ea61025cd391d9 Mon Sep 17 00:00:00 2001
From: Uwe Bonnes <bon@elektron.ikp.physik.tu-darmstadt.de>
Date: Tue, 29 Mar 2011 16:17:43 +0200
Subject: Better explanation of ftdi_read_data() behaviour

diff --git a/src/ftdi.c b/src/ftdi.c
index 9cf425f..de7d81a 100644 (file)
--- a/src/ftdi.c
+++ b/src/ftdi.c
@@ -1547,6 +1547,7 @@ int ftdi_write_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunk
 /**
     Reads data in chunks (see ftdi_read_data_set_chunksize()) from the chip.
 
+    Returns when at least one byte is available or when the latency timer has elapsed
     Automatically strips the two modem status bytes transfered during every read.
 
     \param ftdi pointer to ftdi_context