Skip to content

Commit e3b3c3f

Browse files
committed
iio.h: Fix documentation of iio_create_default_context()
The behaviour of the function changed about one year ago in commit 2e400fa ("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 <[email protected]>
1 parent 4186af2 commit e3b3c3f

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

iio.h

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -349,11 +349,9 @@ __api __check_ret __cnst const char * iio_get_backend(unsigned int index);
349349
* @return On success, A pointer to an iio_context structure
350350
* @return On failure, NULL is returned and errno is set appropriately
351351
*
352-
* <b>NOTE:</b> This function will create a network context if the IIOD_REMOTE
353-
* environment variable is set to the hostname where the IIOD server runs. If
354-
* set to an empty string, the server will be discovered using ZeroConf.
355-
* If the environment variable is not set, a local context will be created
356-
* instead. */
352+
* <b>NOTE:</b> This function will create a context with the URI
353+
* provided in the IIOD_REMOTE environment variable. If not set, a local
354+
* context will be created instead. */
357355
__api __check_ret struct iio_context * iio_create_default_context(void);
358356

359357

0 commit comments

Comments
 (0)