From: Bartosz Golaszewski Date: Fri, 14 Jul 2017 11:25:40 +0000 (+0200) Subject: gpiod.h: improve the documentation for gpiod_line_iter_last_offset() X-Git-Url: http://git.maquefel.me/?a=commitdiff_plain;h=986612c331ac025cbedbde7696884e37e79195e3;p=qemu-gpiodev%2Flibgpiod.git gpiod.h: improve the documentation for gpiod_line_iter_last_offset() Mention the undefined behavior if gpiod_line_iter_last_offset() is ever called before gpiod_line_iter_next(). Signed-off-by: Bartosz Golaszewski --- diff --git a/include/gpiod.h b/include/gpiod.h index 725551b..d56fb4d 100644 --- a/include/gpiod.h +++ b/include/gpiod.h @@ -1082,6 +1082,9 @@ static inline bool gpiod_line_iter_err(const struct gpiod_line_iter *iter) * @param iter The GPIO line iterator object. * @return The offset of the last line we tried to open - whether we failed * or succeeded to do so. + * + * If this function is called before gpiod_line_iter_next() is called at least + * once, the results are undefined. */ static inline unsigned int gpiod_line_iter_last_offset(const struct gpiod_line_iter *iter)