cvs commit: src/share/man/man9 Makefile vm_map_entry_resize_free.9

Mark W. Krentel krentel at
Mon Sep 27 17:50:43 PDT 2004

> 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

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.


More information about the cvs-src mailing list