Match description arguments with synopsis arguments, and
fix style of one function argument description typesetted as .Fn instead of .Fa

Also, .Sh DESCRIPTION differes form .Sh BUFFERS in that
description functions refer (.Fa) argument types but in BUFFERS
function refer (.Fa) to argument names, and confuses me
now that I'm trying to learn about imsg, a patch for that would
be ok?

patch inline and attached in case of mangling.

thanks

Index: imsg_init.3
===================================================================
RCS file: /cvs/src/lib/libutil/imsg_init.3,v
retrieving revision 1.20
diff -u -p -r1.20 imsg_init.3
--- imsg_init.3 6 Dec 2017 12:07:08 -0000 1.20
+++ imsg_init.3 14 Feb 2018 14:42:26 -0000
@@ -181,17 +181,17 @@ returns a pointer to a new message if it
 .Pp
 .Fn imsg_add
 appends to
-.Fa imsg
-.Fa len
+.Fa ibuf
+.Fa datalen
 bytes of ancillary data pointed to by
-.Fa buf .
+.Fa data .
 It returns
 .Fa len
 if it succeeds, \-1 otherwise.
 .Pp
 .Fn imsg_close
 completes creation of
-.Fa imsg
+.Fa ibuf
 by adding it to
 .Fa imsgbuf
 output buffer.
@@ -391,7 +391,7 @@ ready to be sent.
 The
 .Fn ibuf_write
 routine transmits as many pending buffers as possible from
-.Fn msgbuf
+.Fa msgbuf
 using
 .Xr writev 2 .
 It returns 1 if it succeeds, \-1 on error and 0 when no buffers were
Index: imsg_init.3
===================================================================
RCS file: /cvs/src/lib/libutil/imsg_init.3,v
retrieving revision 1.20
diff -u -p -r1.20 imsg_init.3
--- imsg_init.3	6 Dec 2017 12:07:08 -0000	1.20
+++ imsg_init.3	14 Feb 2018 14:42:26 -0000
@@ -181,17 +181,17 @@ returns a pointer to a new message if it
 .Pp
 .Fn imsg_add
 appends to
-.Fa imsg
-.Fa len
+.Fa ibuf
+.Fa datalen
 bytes of ancillary data pointed to by
-.Fa buf .
+.Fa data .
 It returns
 .Fa len
 if it succeeds, \-1 otherwise.
 .Pp
 .Fn imsg_close
 completes creation of
-.Fa imsg
+.Fa ibuf
 by adding it to
 .Fa imsgbuf
 output buffer.
@@ -391,7 +391,7 @@ ready to be sent.
 The
 .Fn ibuf_write
 routine transmits as many pending buffers as possible from
-.Fn msgbuf
+.Fa msgbuf
 using
 .Xr writev 2 .
 It returns 1 if it succeeds, \-1 on error and 0 when no buffers were

Reply via email to