From e3b3c3f226509bb282b54c771f8e3a72541e1bcf Mon Sep 17 00:00:00 2001 From: Paul Cercueil Date: Tue, 25 May 2021 10:27:08 +0100 Subject: [PATCH] iio.h: Fix documentation of iio_create_default_context() The behaviour of the function changed about one year ago in commit 2e400fae ("getenv : keep Windows happy by using _dupenv_s rather than getenv") without anybody noticing; so fix the documentation so that it describes better the current behaviour. Signed-off-by: Paul Cercueil --- iio.h | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/iio.h b/iio.h index f597963d0..ccc83be84 100644 --- a/iio.h +++ b/iio.h @@ -349,11 +349,9 @@ __api __check_ret __cnst const char * iio_get_backend(unsigned int index); * @return On success, A pointer to an iio_context structure * @return On failure, NULL is returned and errno is set appropriately * - * NOTE: This function will create a network context if the IIOD_REMOTE - * environment variable is set to the hostname where the IIOD server runs. If - * set to an empty string, the server will be discovered using ZeroConf. - * If the environment variable is not set, a local context will be created - * instead. */ + * NOTE: This function will create a context with the URI + * provided in the IIOD_REMOTE environment variable. If not set, a local + * context will be created instead. */ __api __check_ret struct iio_context * iio_create_default_context(void);