Re: imsg_get undocumented

Theo Buehler <[email protected]> Thu, 23 Jul 2026 16:06:48 +0200
Newsgroups gmane.os.openbsd.bugs
Message-ID <[email protected]>
On Tue, Jul 21, 2026 at 10:58:32PM +0200, Claudio Jeker wrote:
> imsg_get is on the way out. It was renamed to imsgbuf_get() and the return
> value was simplified. Fixing all of the tree still needs to happen.

We should either document this or at least we should indicate that its
omissiong isn't an oversight. In libcrypto we add a marker like this:

Index: imsg_init.3
===================================================================
RCS file: /cvs/src/lib/libutil/imsg_init.3,v
diff -u -p -r1.46 imsg_init.3
--- imsg_init.3	13 Jun 2025 18:34:00 -0000	1.46
+++ imsg_init.3	21 Jul 2026 21:40:46 -0000
@@ -48,6 +48,8 @@
 .Nm imsgbuf_read ,
 .Nm imsgbuf_set_maxsize ,
 .Nm imsgbuf_write
+.\" .Nm imsg_get is intentionally undocumented
+.\" because imsgbuf_get should be used instead.
 .Nd IPC messaging functions
 .Sh SYNOPSIS
 .Lb libutil