From 1bdb669467100fac659951db589a67eb20435372 Mon Sep 17 00:00:00 2001 From: Bartosz Golaszewski Date: Tue, 15 Sep 2020 11:48:52 +0200 Subject: [PATCH] doc: improve the part about non-unique line names The current comments for functions related to line lookups state that "lines are not unique" but they're really supposed to say "line names are not unqiue". Signed-off-by: Bartosz Golaszewski --- include/gpiod.h | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/include/gpiod.h b/include/gpiod.h index d1f9830..3477f9d 100644 --- a/include/gpiod.h +++ b/include/gpiod.h @@ -541,9 +541,9 @@ int gpiod_ctxless_event_monitor_multiple_ext( * the line was found. In the first two cases the contents of chipname * and offset remain unchanged. * @note The chip name is truncated if the buffer can't hold its entire size. - * @attention GPIO lines are not unique in the linux kernel, neither globally - * nor within a single chip. This function finds the first line with - * given name. + * @attention GPIO line names are not unique in the linux kernel, neither + * globally nor within a single chip. This function finds the first + * line with given name. */ int gpiod_ctxless_find_line(const char *name, char *chipname, size_t chipname_size, @@ -669,9 +669,9 @@ int gpiod_chip_get_all_lines(struct gpiod_chip *chip, * found or an error occurred. * @note In case a line with given name is not associated with given chip, the * function sets errno to ENOENT. - * @attention GPIO lines are not unique in the linux kernel, neither globally - * nor within a single chip. This function finds the first line with - * given name. + * @attention GPIO line names are not unique in the linux kernel, neither + * globally nor within a single chip. This function finds the first + * line with given name. */ struct gpiod_line * gpiod_chip_find_line(struct gpiod_chip *chip, const char *name) GPIOD_API; @@ -685,9 +685,9 @@ gpiod_chip_find_line(struct gpiod_chip *chip, const char *name) GPIOD_API; * @return 0 if all lines were located, -1 on error. * @note If at least one line from the list could not be found among the lines * exposed by this chip, the function sets errno to ENOENT. - * @attention GPIO lines are not unique in the linux kernel, neither globally - * nor within a single chip. This function finds the first line with - * given name. + * @attention GPIO line names are not unique in the linux kernel, neither + * globally nor within a single chip. This function finds the first + * line with given name. */ int gpiod_chip_find_lines(struct gpiod_chip *chip, const char **names, struct gpiod_line_bulk *bulk) GPIOD_API; -- 2.30.2