From ce6961d1653a62131efdadc5907a917b2dd016d5 Mon Sep 17 00:00:00 2001 From: Benjamin Berg Date: Mon, 7 Sep 2020 12:12:34 +0200 Subject: [PATCH] image-device: Fix cancellation documentation Image devices are simply deactivated suddenly. As such, the cancellation logic of FpDevice is not really useful there, but the documentation was apparently accidentally copied unmodified. --- libfprint/fpi-image-device.h | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/libfprint/fpi-image-device.h b/libfprint/fpi-image-device.h index 155390d..43492d8 100644 --- a/libfprint/fpi-image-device.h +++ b/libfprint/fpi-image-device.h @@ -72,9 +72,8 @@ typedef enum { * fpi_device_action_error() function but doing so is not recommended in most * usecases. * - * Drivers *must* also handle cancellation properly for any long running - * operation (i.e. any operation that requires capturing). It is entirely fine - * to ignore cancellation requests for short operations (e.g. open/close). + * Image drivers must expect a @deactivate call to happen at any point during + * image capture. * * This API is solely intended for drivers. It is purely internal and neither * API nor ABI stable.