doc: document the caveat concerning line lookups
authorBartosz Golaszewski <bgolaszewski@baylibre.com>
Thu, 6 Aug 2020 19:53:03 +0000 (21:53 +0200)
committerBartosz Golaszewski <bgolaszewski@baylibre.com>
Thu, 6 Aug 2020 19:55:37 +0000 (21:55 +0200)
commit9ffa2afd8c405f72869499d77578e26a3377c723
tree958a1c32f69132cf8ccd9f70c2bdac8cf6b31e64
parent72414e0cf31707bdb8170a47e97cc9b586ffac84
doc: document the caveat concerning line lookups

GPIO line names in the kernel aren't unique - neither globally nor
within a single chip. The current API doesn't take this into
consideration and simply returns the first matching line in
gpiod_line_find() and co.

This will be addressed in v2.0 but we can't fix it in v1.x without
introducing new interfaces and deprecating the ones that already exist.

Let's document this behavior in doxygen comments for all affected
routines.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>
include/gpiod.h