Re: Documentation files in html format?

From: Andi Kleen
Date: Thu Aug 09 2007 - 10:32:11 EST


Hans-Jürgen Koch <hjk@xxxxxxxxxxxxx> writes:

> Am Donnerstag 09 August 2007 12:31 schrieb Stephen Hemminger:
> > Since the network device documentation needs a rewrite, I was thinking
> > of using basic html format instead of just plain text.
>
> Why don't you simply use DocBook? Then the user has the choice to convert
> to HTML, PDF, LaTex or whatever.

In my experience it tends to be challenging to actually find all the packages
needed for that. And then it's incredibly slow -- seems to be much slower
than gcc which is somewhat of an archivement. And at least for LinuxDoc TeX usually
can't even compile the result.

I would say the track record of existing DocBook deployment is not good enough
to justify further use. Plain html can be converted into all these
formats easily too and overall it makes a much nicer user experience.

Also I would expect much more people will know how to write html versus
DocBook.

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