Re: Documentation files in html format?

[Rene Herman]

On 08/10/2007 10:12 PM, Sam Ravnborg wrote:

> > What primary requirements does in-tree Linux kernel documentation have
> > to fulfill in general?
>
> Skipping the obvious ones such as correct, up-to-date etc.
> o Readable as-is
> o Grepable
> o buildable as structured documents or almost like a single book
> o Easy to replicate structure
> o Maintainable in any decent text-editor (emacs, vim, whatever)

Easy to put online?

> Asciidoc is quite close to plaintext and it looks to me that the
> formatting possibilities are quite good.
>
> I spend an hour experimenting a little with
> Documentation/kbuild/makefiles.txt.
>
> Diff below shows quite a lot of changes but for the most
> this is removal of the indent tab.
> Most likely I could have tweaked asciidoc to accept this
> but wanted to use default config.
>
> The resulting html page can be seen here:
> http://www.ravnborg.org/kbuild/makefiles.html

FWIW, this looks very good to me...

Rene.

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