On Fri, 26 Oct 2007, Diego Novillo wrote:
> So, I think the problem goes a bit beyond mere documentation of how a
> module works at a high level. I would like to have a navigable
> document that also describes the flow of things, interfaces and
> helpers. Starting at main.c:main() and ending at t
On 10/26/07, Basile STARYNKEVITCH <[EMAIL PROTECTED]> wrote:
> Maybe a possible approach would be to use literate programming
> techniques; By previous experience (still limited), I would believe that
> it would be more worthwhile on the interface files (ie the *.h files,
> some *.opt, etc...) tha
On Fri, 2007-10-26 at 19:34 +0200, Basile STARYNKEVITCH wrote:
> Diego Novillo wrote:
> I am more thinking loud than actually believing that it would be a good
> idea to switch to literate programming; I have mixed feelings towards
> this approach, which has been extensively used in the C-- com
Diego Novillo wrote:
This idea is still very raw in my mind, so apologies in advance for
being deliberately vague. For the last few weeks I have been thinking
on ways to address the sorry state of our internal documentation.
We all agree that none of us has global knowledge of all aspects of
th
