Re: [MiNT] Kernel documentation shortcomings

[Alan Hourihane <alanh@fairlite.co.uk>]

On Mon, 2010-08-23 at 16:20 +0200, m0n0 wrote:
> Am Montag, den 23.08.2010, 16:05 +0200 schrieb Alan Hourihane
> <alanh@fairlite.co.uk>:
> 
> 
> > Sure. We want ALL the docs.
> 
> I didn't meant to destroy any information ;) 
>  
> >> Of course we could write an converter, from wiki to man page... but
> >> maybe it would be better if a small script translates them to wiki
> >> content?
> > 
> > Whatever works for you to get the stuff into the wiki. I'm easy.
> 
> I'm not talking about an one time script... I'm talking about the place
> where the documentation should be maintained.
> The programmers must accept/decide how/where the kernel will be
> documentet... and I remember many people said that it is essential to
> keep documentation where the source is ;) That's also my point of view.
> If we can keep documents (in their current form) in the kernel - that's
> good. That means we don't need to import into the wiki, export them,
> convert them, place them into the release... We could simple take the
> up-to-date docs from freemint trunk ;) 
> 
> Importing these docs to the wiki is another part of the documentation
> process then... (not that much work).
> 
> I vote for docs integrated into the sources. 

I don't see why we can't have both and eat our cake.

Basically if it's all in the wiki, then a converter can easily push it
back into a document that's shippable with a release.

Having documentation in the CVS makes life a little harder for those who
don't use CVS, where as wiki's are readily available and are
user-friendly.

So I'd really like to get 99% of the docs out of the CVS.

Alan.