From owner-freebsd-hackers@FreeBSD.ORG Fri Oct 19 17:07:03 2007 Return-Path: Delivered-To: freebsd-hackers@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34]) by hub.freebsd.org (Postfix) with ESMTP id 8BA0816A418 for ; Fri, 19 Oct 2007 17:07:03 +0000 (UTC) (envelope-from julian@elischer.org) Received: from outB.internet-mail-service.net (outB.internet-mail-service.net [216.240.47.225]) by mx1.freebsd.org (Postfix) with ESMTP id 6D60713C478 for ; Fri, 19 Oct 2007 17:06:59 +0000 (UTC) (envelope-from julian@elischer.org) Received: from mx0.idiom.com (HELO idiom.com) (216.240.32.160) by out.internet-mail-service.net (qpsmtpd/0.40) with ESMTP; Fri, 19 Oct 2007 10:06:56 -0700 X-Client-Authorized: MaGic Cook1e X-Client-Authorized: MaGic Cook1e X-Client-Authorized: MaGic Cook1e Received: from julian-mac.elischer.org (nat.ironport.com [63.251.108.100]) by idiom.com (Postfix) with ESMTP id 832DD126757; Fri, 19 Oct 2007 10:06:55 -0700 (PDT) Message-ID: <4718E43F.1020303@elischer.org> Date: Fri, 19 Oct 2007 10:07:11 -0700 From: Julian Elischer User-Agent: Thunderbird 2.0.0.6 (Macintosh/20070728) MIME-Version: 1.0 To: Ed Schouten References: <20071016094118.GE5411@hoeg.nl> <200710170916.18788.jhb@freebsd.org> <20071019045654.GF5411@hoeg.nl> In-Reply-To: <20071019045654.GF5411@hoeg.nl> Content-Type: text/plain; charset=ISO-8859-1; format=flowed Content-Transfer-Encoding: 7bit Cc: FreeBSD Hackers Subject: Re: Inner workings of turnstiles and sleepqueues X-BeenThere: freebsd-hackers@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: Technical Discussions relating to FreeBSD List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 19 Oct 2007 17:07:03 -0000 Ed Schouten wrote: > * John Baldwin wrote: >> The best option right now is to read the code. There are some comments in >> both the headers and implementation. > > Would it be useful to write manpages for these interfaces, or do we > assume that only godlike people can use them anyway? I am willing to > write manpages for them. > > Yours, man pages are ALWAYS a good idea. (well, NEARLY always.) it may be that this information may go well into an exisiting man page, or at least a description. I believe that to some extent they are supposed to be an internal interface so maybe a description as part of the utilities that use them may be in order.. also think about whether a paragraph might go into locking(9). I'm still trying to nag john to run an editing pass over locking(9)