depau/libfprint
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

image-device: Fix cancellation documentation

Browse source 
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.
This commit is contained in:
Benjamin Berg 2020-09-07 12:12:34 +02:00
parent 30e1a68344
commit ce6961d165
1 changed files with 2 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
libfprint/fpi-image-device.h
View file

@ -72,9 +72,8 @@ typedef enum {
* fpi_device_action_error() function but doing so is not recommended in most * fpi_device_action_error() function but doing so is not recommended in most
* usecases. * usecases.
* *
* Drivers *must* also handle cancellation properly for any long running * Image drivers must expect a @deactivate call to happen at any point during
* operation (i.e. any operation that requires capturing). It is entirely fine * image capture.
* to ignore cancellation requests for short operations (e.g. open/close).
* *
* This API is solely intended for drivers. It is purely internal and neither * This API is solely intended for drivers. It is purely internal and neither
* API nor ABI stable. * API nor ABI stable.