From 5f6d42a56dfcfb087e907b5206f9829dc955e758 Mon Sep 17 00:00:00 2001 From: Bartosz Golaszewski Date: Tue, 28 Apr 2020 13:24:19 +0200 Subject: [PATCH] doc: improve the description of gpiod_line_event_read() The description of gpiod_line_event_read() states that it reads the last event that occurred for this line. This is not true: the kernel stores the events in a FIFO and this function reads the next event from it. Fix the confusing statement. Signed-off-by: Bartosz Golaszewski --- include/gpiod.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/gpiod.h b/include/gpiod.h index 9820362..3af97c4 100644 --- a/include/gpiod.h +++ b/include/gpiod.h @@ -1490,7 +1490,7 @@ int gpiod_line_event_wait_bulk(struct gpiod_line_bulk *bulk, struct gpiod_line_bulk *event_bulk) GPIOD_API; /** - * @brief Read the last event from the GPIO line. + * @brief Read next pending event from the GPIO line. * @param line GPIO line object. * @param event Buffer to which the event data will be copied. * @return 0 if the event was read correctly, -1 on error. -- 2.30.2