Re: CVS commit: src

[Mindaugas Rasiukevicius <rmind%netbsd.org@localhost>]

yamt%mwd.biglobe.ne.jp@localhost (YAMAMOTO Takashi) wrote:
> > Log Message:
> > Unify kmem_alloc/zalloc/free under kmem(9).  Links preserved.
> 
> i intentionally made them separate pages because
> it's easier to read for me.  (ie. no need to search in a man page.)

I think we should have a manual per-subsystem:

- We already have some practices of writing documentation is such way,
  like mutex(9), rwlock(9), softint(9), vnode(9) and bunch of others.
  And I would like to keep such consistent structure.

- Reading bit-by-bit, via "see also" links and creating an overall image
  of subsystem in such way is quite disturbing, in my opinion.

- On the other hand, uvm(9) is an example where manual page is too heavy.
  Each part is complicated enough and could be taken as a separate system.

- Single man pages for each function are getting generally messy. They get
  "lost" by reader and are often outdated.

Therefore, attempting to get some consistent and readable structure.

> YAMAMOTO Takashi

-- 
Mindaugas