From owner-cvs-src@FreeBSD.ORG Tue Sep 28 00:50:43 2004 Return-Path: Delivered-To: cvs-src@freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 12D0416A4CE; Tue, 28 Sep 2004 00:50:43 +0000 (GMT) Received: from mail2.dreamscape.com (mail2.dreamscape.com [206.64.128.18]) by mx1.FreeBSD.org (Postfix) with ESMTP id 91A2943D5F; Tue, 28 Sep 2004 00:50:40 +0000 (GMT) (envelope-from krentel@dreamscape.com) Received: from blue.mwk.domain (sA19-p63.dreamscape.com [209.217.200.126]) i8S0obnO011850; Mon, 27 Sep 2004 20:50:38 -0400 (EDT) Received: from blue.mwk.domain (localhost [127.0.0.1]) by blue.mwk.domain (8.12.9p2/8.12.9) with ESMTP id i8S0owSb037260; Mon, 27 Sep 2004 20:50:59 -0400 (EDT) (envelope-from krentel@blue.mwk.domain) Message-Id: <200409280050.i8S0owSb037260@blue.mwk.domain> To: das@FreeBSD.ORG Date: Mon, 27 Sep 2004 20:50:58 -0400 From: "Mark W. Krentel" cc: alc@FreeBSD.ORG cc: cvs-src@FreeBSD.ORG Subject: Re: cvs commit: src/share/man/man9 Makefile vm_map_entry_resize_free.9 X-BeenThere: cvs-src@freebsd.org X-Mailman-Version: 2.1.1 Precedence: list List-Id: CVS commit messages for the src tree List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 28 Sep 2004 00:50:43 -0000 > This is documentation for a simple static function, so doesn't it > belong in vm_map.c as a comment, where it is less likely to rot? The true purpose of the man page is to describe the rules for maintaining consistency of the free space variables (adj_free and max_free). I wanted to elaborate on the free space algorithm in a format that was too long for program comments, so I chose a manual page. But that brings up the question of the right name for the man page. Theoretically, vm_map(9) would make sense because adj_free is a field in struct vm_map_entry. But combining the two pages would clearly have the tail wagging the dog. Another possibility is to pick an original name, say vm_map_freespace(9). But Alan was concerned about choosing a name that looked like a function or struct but wasn't one. Finally, we compromised on vm_map_entry_resize_free(9) since any discussion on the free space algorithm has to mention this function anyway. Anyway, I think it's really too long for program comments, but feel free to suggest a better man page name. --Mark