grub-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Documentation.


From: Tomas Ebenlendr
Subject: Documentation.
Date: Thu, 24 Jun 2004 19:10:29 +0200
User-agent: Mutt/1.5.6i

I think that there is terribly missing a documentation of grub
internals. I want to write documentation at least for parts which I'm
patching. Otherwise everyone who wants to hack for grub:
    a) slowly figures out how things are workinkg.
    b) hacks in way which _he_ supposes to be consistent with other
    parts.
This can be fixed by documentation. Programmer then can read apropriate
part of documentation and learn how things are _intended_ to be.

So here is the question: what format? (and what names?).

I'm used on doxygen, but I think it is piece of crap (because text
processing shouln't be written in C).

It can be plain text (it is only for programmer's), but there should be
written how grub works (and is intended to work), so programmer can
easily figure out what he wants to patch.


-- 
                                 Tomas 'ebi' Ebenlendr
                                 http://get.to/ebik
                                 PF 2004.48028928861





reply via email to

[Prev in Thread] Current Thread [Next in Thread]