NetBSD Problem Report #58623

From www@netbsd.org  Tue Aug 20 23:36:55 2024
Return-Path: <www@netbsd.org>
Received: from mail.netbsd.org (mail.netbsd.org [199.233.217.200])
	(using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)
	 key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256
	 client-signature RSA-PSS (2048 bits) client-digest SHA256)
	(Client CN "mail.NetBSD.org", Issuer "mail.NetBSD.org CA" (not verified))
	by mollari.NetBSD.org (Postfix) with ESMTPS id 5FF0F1A923F
	for <gnats-bugs@gnats.NetBSD.org>; Tue, 20 Aug 2024 23:36:55 +0000 (UTC)
Message-Id: <20240820233654.5D1EF1A9242@mollari.NetBSD.org>
Date: Tue, 20 Aug 2024 23:36:54 +0000 (UTC)
From: campbell+netbsd@mumble.net
Reply-To: campbell+netbsd@mumble.net
To: gnats-bugs@NetBSD.org
Subject: KASSERT(9) man page is vague about what header file it needs
X-Send-Pr-Version: www-1.0

>Number:         58623
>Category:       kern
>Synopsis:       KASSERT(9) man page is vague about what header file it needs
>Confidential:   no
>Severity:       serious
>Priority:       medium
>Responsible:    kern-bug-people
>State:          open
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Tue Aug 20 23:40:01 +0000 2024
>Originator:     Taylor R Campbell
>Release:        current, 10, 9, ...
>Organization:
The KNETBSD(9) Foundation
>Environment:
>Description:
The KASSERT(9) man page doesn't say what header file you're supposed to include to get at it.
>How-To-Repeat:
rtfm
>Fix:
Yes, please!

Obvious candidates:

#include <lib/libkern/libkern.h>
#include <sys/systm.h>

I don't like either of these, really -- hodgepodge piles of miscellany like this shouldn't exist; header files should have clear definite purposes with limited scope.  But one of those is probably the right thing to document for now.

Home	PR Database Search