lkml.org 
[lkml]   [2003]   [Oct]   [14]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: make htmldocs
On Tue, 14 Oct 2003, [iso-8859-2] Karel Kulhavý wrote:

> I suggest considering replacing the DocBook bloatware for something
> more sane in the kernel tree. You could maybe generate the html
> docs yourself and simply put them somewhere into the Documentation/
> directory into the kernel sources. Or at least on the web, but then
> the people offline couldn't even read the instruction manual for their
> kernel.

It's not the instruction manual. It's kernel API documentation, for the
kernel code, used by kernel developers.

Then again, I'm happy to be wrong on this. I suggest you develop and
submit a patch to address your concerns. The patch should probably take
account of:

- the existing formatted documentation comments
- the existing code to turn those comments into docbook
(scripts/kernel-doc)
- the existing man page generation scripts (scripts/makeman
scripts/split-man)
- the difficulty of keeping separate HTML documentation in sync with the
code
- the fact that docbook is the accepted standard for open source
documentation (including the ldp)

I look forward to reading your patch.

Cheers,
Mikal

--

Michael Still (mikal@stillhq.com) | "All my life I've had one dream,
http://www.stillhq.com | to achieve my many goals"
UTC + 10 | -- Homer Simpson

-
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/

\
 
 \ /
  Last update: 2005-03-22 13:49    [W:0.091 / U:10.604 seconds]
©2003-2018 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site