]> sigrok.org Git - libserialport.git/commitdiff
Update documentation.
authorMartin Ling <redacted>
Sun, 3 Nov 2013 23:12:03 +0000 (23:12 +0000)
committerUwe Hermann <redacted>
Thu, 14 Nov 2013 23:42:39 +0000 (00:42 +0100)
README

diff --git a/README b/README
index ae96bea228182e2f5ea1a472b80e3db166f2b116..6e3b480129b683e36104bf03609de245fc056eab 100644 (file)
--- a/README
+++ b/README
@@ -61,8 +61,9 @@ API
 The API is simple, and designed to be a minimal wrapper around the serial port
 support in each OS.
 
-Most functions take a pointer to a struct sp_port, which represents an serial
-port. This structure is obtained from the array returned by sp_list_ports().
+Most functions take a pointer to a struct sp_port, which represents a serial
+port. These structures are always allocated and freed by the library, using the
+functions in the 'Enumeration' section below.
 
 All functions can return only three possible error values. SP_ERR_ARG indicates
 the function was called with invalid arguments. SP_ERR_FAIL indicates that the