Re: [PATCH] Page replacement documentation

Mel (mel@csn.ul.ie)
Fri, 17 May 2002 15:01:18 +0100 (IST)


On Fri, 17 May 2002, Alan Cox wrote:

> > + ----------------------------------------------------------------------
> > +
> > + This document was translated from LATEX by HEVEA.
>
> If you switched it into DocBook format then the kernel shipped tools
> will generate a document from it including html/pdf/ps etc as well as
> being able to embed stuff
>

I'll look into it. I find DocBook very verbose to write in at the moment
and much prefer LaTeX but I'm guessing I won't have a lot of choice in the
matter when I release the rest of the documentation if anyone else is
going to build on it.

> > +/*
> > + * shink_cache - Shrinks buffer caches in a zone
> > + * nr_pages: Helps determine if process information needs to be sweapped
>
> You've not tested these. They should start
>

In this case, it was deliberate. I didn't want shrink_cache to be
advertised on the kernel-doc because it's not a function people outside of
vmscan.c should be calling so did not see the point in having it picked
up.

-- 
			Mel Gorman

- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/