From: Uwe Hermann <redacted>
Date: Sat, 30 May 2015 20:04:56 +0000 (+0200)
Subject: NEWS: Update for the upcoming 0.1.1 release.
X-Git-Tag: libserialport-0.1.1~20
X-Git-Url: https://sigrok.org/gitaction?a=commitdiff_plain;h=e2b7ba1214a5e16f767975098ae406bbd5aa3d6a;p=libserialport.git

NEWS: Update for the upcoming 0.1.1 release.
---

diff --git a/NEWS b/NEWS
index 94dab4f..d34360d 100644
--- a/NEWS
+++ b/NEWS
@@ -1,10 +1,66 @@
-next
+0.1.1 (2015-xx-yy)
 ------------------
 
- * New API to obtain a user friendly port description: sp_get_port_description().
- * New API to obtain the underlying transport type: sp_get_port_transport().
- * New API to obtain USB device details: sp_get_port_usb_*().
- * New API to obtain Bluetooth MAC address: sp_get_port_bluetooth_address().
+Note: This release does NOT change the libserialport API or ABI in
+      backwards-incompatible ways. Programs using libserialport should
+      continue to work fine without recompiling or relinking.
+
+ * New API calls:
+   - sp_get_port_description(): Obtain a user friendly port description.
+   - sp_get_port_transport(): Obtain the underlying transport type.
+   - sp_get_port_usb_bus_address(): Obtain the USB bus number & device address.
+   - sp_get_port_usb_vid_pid(): Obtain the USB VID and PID.
+   - sp_get_port_usb_manufacturer(): Obtain the USB manufacturer string.
+   - sp_get_port_usb_product(): Obtain the USB product string.
+   - sp_get_port_usb_serial(): Obtain the USB serial number string.
+   - sp_get_port_bluetooth_address(): Obtain the Bluetooth MAC address.
+   - sp_blocking_read_next(): Read bytes from the specified serial port,
+     returning as soon as any data is available.
+ * API related additions:
+   - enum sp_mode: Add SP_MODE_READ_WRITE.
+   - Add enum sp_transport with the following enum entries:
+     SP_TRANSPORT_NATIVE, SP_TRANSPORT_USB, SP_TRANSPORT_BLUETOOTH.
+ * Fix the build on platforms where port enumeration and/or port
+   metadata is not available or implemented.
+ * Build system: Don't set/override "user variables" such as CFLAGS or
+   LDFLAGS, since those are meant to be controlled by the "user" (bug #577).
+ * Remove trailing commas in libserialport.h enum definitions to allow
+   the code to build with the -pedantic compiler option.
+ * Fix various issues to allow successful builds with -std=c99.
+ * Fix various (non-fatal) compiler warnings.
+ * Fix various memory leaks (bug #419, among others).
+ * Rename a 'signals' parameter to 'signal_mask' to avoid a conflict with Qt.
+ * Fix two potential segfaults in sp_get_port_handle() and sp_get_config_*()
+   (which only occurred if the user incorrectly passed in a NULL argument).
+ * sp_list_ports(): Actually set list_ptr NULL as documented.
+ * Linux:
+   - The libudev requirement has been dropped (/sys is now used directly).
+   - Fix a build issue in the get_termios_get_ioctl() call (bug #396).
+   - Fix sp_flush() so that it only flushes the requested buffers.
+   - Fix a build error if BOTHER is not available (bug #363).
+   - If present, add the USB "description" for better port identification.
+   - Handle the case when /sys/class/tty/ entries are not symlinks.
+ * Windows:
+   - MinGW-w64 (mingw-w64.sf.net) is now required for building, and MinGW
+     (mingw.org) is no longer supported (bug #393).
+   - Fix a build issue due to a missing <initguid.h> #include.
+   - Fix a build issue due to the missing -lsetupapi linker argument.
+   - Use libtool's -no-undefined option to allow shared (DLL) builds.
+   - Fix a compile error due to multiply or not defined GUIDs (bug #416).
+   - Fix a build issue related to the SP_PRIV/SP_API macros (bug #553).
+   - Fix a bug where an uninitialized pointer was free()'d (bug #512).
+   - Fix a bug wrt the SetupDiOpenDevRegKey() return code (bug #499).
+   - Fix a bug wrt restart of RX/error wait operations after read (bug #421).
+   - Fix a bug wrt WaitCommEvents() and/or fAbortOnError handling (bug #341).
+   - Strip CR/LF from end of system error messages (bug #585).
+   - Avoid unnecessary calls to the SetCommTimeouts() function (bug #586).
+ * FreeBSD:
+   - Implement serial port enumeration for FreeBSD systems.
+ * Android:
+   - Fix a portability issue wrt the unavailable 'serial_struct' (bug #376).
+   - Fix a portability issue wrt a readlinkat() call (bug #377).
+ * README: Various documentation updates and fixes.
+ * Doxygen API docs: Various documentation updates and fixes.
 
 0.1.0 (2014-05-06)
 ------------------