Date: Fri, 3 Oct 2003 19:00:28 -0700 From: David Schultz <das@FreeBSD.ORG> To: Bruce M Simpson <bms@FreeBSD.ORG> Cc: cvs-all@FreeBSD.ORG Subject: Re: cvs commit: src/share/man/man9 Makefile pmap.9 pmap_is_prefaultable.9 vm_fault_prefault.9 Message-ID: <20031004020028.GA65508@VARK.homeunix.com> In-Reply-To: <200310040130.h941U2Ti032910@repoman.freebsd.org> References: <200310040130.h941U2Ti032910@repoman.freebsd.org>
next in thread | previous in thread | raw e-mail | index | archive | help
On Fri, Oct 03, 2003, Bruce M Simpson wrote: > bms 2003/10/03 18:30:02 PDT > > FreeBSD src repository > > Modified files: > share/man/man9 Makefile pmap.9 > Added files: > share/man/man9 pmap_is_prefaultable.9 > vm_fault_prefault.9 > Log: > Update the pmap(9) documentation to reflect the movement of pmap_prefault() > to the machine-independent VM layer, as per alc's recent commit. > Add a definition for the new pmap_is_prefaultable() helper function. I appreciate the work that you're doing to document the VM system, but I'm wondering if it isn't more appropriate to put this sort of documentation above the functions themselves. These interfaces are private to the VM system anyway, so documenting them separately is just asking for those documents to get out of date. I'm wondering if your effort would not be better spent improving the comments in the source code instead. dillon has already done a good deal of that, but there is still some dyson code out there that could use some work in this area. Just a thought...
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20031004020028.GA65508>