summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarco Trevisan (Treviño) <mail@3v1n0.net>2020-02-28 15:23:51 +0100
committerMarco Trevisan (Treviño) <mail@3v1n0.net>2020-02-28 17:49:44 +0100
commitb1cf057468a4a5a72da1a7e484f86a45b04ac580 (patch)
tree186c9169f2907d6e065375b5489b8a0cd12e977a
parentb2a78ddadcf4ba70204f72e348f406925c3beb69 (diff)
Bump libfprint-tod version to v1.90.1+tod1v1.90.1+tod1
-rw-r--r--NEWS.tod.md25
-rw-r--r--meson.build2
2 files changed, 26 insertions, 1 deletions
diff --git a/NEWS.tod.md b/NEWS.tod.md
new file mode 100644
index 0000000..66e764f
--- /dev/null
+++ b/NEWS.tod.md
@@ -0,0 +1,25 @@
+### libfprint-TOD v1
+
+- First public release
+- Based on [libfprint 1.90.1](https://gitlab.freedesktop.org/libfprint/libfprint/-/releases#v1.90.1)
+- Bumped TOD version to 1
+
+### Highlights of the Drivers API changes
+
+Both the driver and external APIs have changed, as both the verify and the identify functions now have early reporting mechanisms.
+
+- Added API for early report of matching results or retry errors
+- Verify and identification completion functions have been simplified
+- Support variadic arguments in error functions
+- Various re-definitions of ownership handling
+- Add convenience API to change state after a timeout
+- Add unit tests for all the drivers API
+
+### Drivers required changes
+As per the early report mechanism, drivers need to adapt, in particular:
+ - New pkg-config dependency name is `libfprint-2-tod-1`
+ - Verification and Identification API for non-image drivers has changed and drivers need to both `report` the result of the action and complete it:
+ - `fpi_device_{verify,identify}_report` must inform whether a match/no-match or identification happened or report a *retry error*.
+ - `fpi_device_{verify,identify}_complete` must be called once the device has completed the verification / identification process, in case reporting device errors (not retry ones!)
+
+You can see examples of changes needed in the [reference example driver](https://gitlab.freedesktop.org/3v1n0/libfprint-tod-example-driver/-/commit/8308f84f7d1cfd1b9ed0936c13c73b43a4a46772) or the [upstream synaptics driver](https://gitlab.freedesktop.org/libfprint/libfprint/-/merge_requests/112/diffs)
diff --git a/meson.build b/meson.build
index 8d35d92..ccc68fe 100644
--- a/meson.build
+++ b/meson.build
@@ -1,5 +1,5 @@
project('libfprint', [ 'c', 'cpp' ],
- version: '1.90.1',
+ version: '1.90.1+tod1',
license: 'LGPLv2.1+',
default_options: [
'buildtype=debugoptimized',