Skip to content

Commit

Permalink
add new option and description to man page
Browse files Browse the repository at this point in the history
Signed-off-by: Robin Getz <[email protected]>
  • Loading branch information
rgetz committed Mar 13, 2020
1 parent b12d050 commit 3037476
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions man/make_man.sh
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,22 @@ subsystem and devices
.sp
cc file.c
.B -liio
.SH OPTIONS
The define
.B
IIO_CHECK_REG
will warn if return values are not checked. Most
.B
libiio
functions, if/when a failure occurs will return a negative error number.
this warning will ensure these error numbers are looked at. There is
nothing more frustraining than calling a function, debugging some hardware,
and then eventually realizing there was a typo in an attribute name.
This option will force libraries users to at least capture the return value.
.sp
cc file.c
.B -DIIO_CHECK_REG -liio
.SH DESCRIPTION
.I libiio
is a library used to interface to the
Expand Down

0 comments on commit 3037476

Please sign in to comment.