NetBSD-Bugs archive

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]

misc/41436: Incorrect reference in iic(9) man-page



>Number:         41436
>Category:       misc
>Synopsis:       Incorrect reference in iic(9) man-page
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    misc-bug-people
>State:          open
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Fri May 15 17:40:01 +0000 2009
>Originator:     Jukka Ruohonen
>Release:        NetBSD 5.0_STABLE
>Organization:
-
>Environment:
-

>Description:

The iic(9) manual page refers to "buflen" but the listed prototypes only
contain "len".

>How-To-Repeat:

man iic

>Fix:

Either replace all references to "len" by "buflen" or correct the one
reference to "buflen" by "len". As "buflen" is used in the source code, the
following diff does the former, which I think is more articulate too.

Index: iic.9
===================================================================
RCS file: /cvsroot/src/share/man/man9/iic.9,v
retrieving revision 1.3
diff -u -p -r1.3 iic.9
--- iic.9       2 Feb 2007 07:37:06 -0000       1.3
+++ iic.9       15 May 2009 17:23:06 -0000
@@ -65,7 +65,7 @@
 .Fa "const void *cmdbuf"
 .Fa "size_t cmdlen"
 .Fa "void *buf"
-.Fa "size_t len"
+.Fa "size_t buflen"
 .Fa "int flags"
 .Fc
 .Ft int
@@ -163,7 +163,7 @@ flag was passed to
 .Fn iic_acquire_bus ,
 it must also be passed to
 .Fn iic_release_bus .
-.It Fn iic_exec "ic" "op" "addr" "cmdbuf" "cmdlen" "buf" "len" "flags"
+.It Fn iic_exec "ic" "op" "addr" "cmdbuf" "cmdlen" "buf" "buflen" "flags"
 Perform a series of I2C transactions on the bus.
 .Fn iic_exec
 initiates the operation by sending a START condition on the I2C
@@ -200,7 +200,7 @@ This is equivalent to
 I2C_OP_WRITE_WITH_STOP with
 .Fa cmdlen
 of 1 and
-.Fa len
+.Fa buflen
 of 1.
 .It Fn iic_smbus_read_byte "ic" "addr" "cmd" "datap" "flags"
 Perform an SMBus READ BYTE operation.
@@ -208,7 +208,7 @@ This is equivalent to
 I2C_OP_READ_WITH_STOP with
 .Fa cmdlen
 of 1 and
-.Fa len
+.Fa buflen
 of 1.
 .It Fn iic_smbus_receive_byte "ic" "addr" "datap" "flags"
 Perform an SMBus RECEIVE BYTE operation.
@@ -216,7 +216,7 @@ This is equivalent to
 I2C_OP_READ_WITH_STOP with
 .Fa cmdlen
 of 0 and
-.Fa len
+.Fa buflen
 of 1.
 .El
 .Sh CONTROLLER INTERFACE



Home | Main Index | Thread Index | Old Index