Ticket #959 (new todo)

Opened 5 years ago

Last modified 3 years ago

Auto-generate #include dependency graphs in docs/ at build.

Reported by: jrtayloriv Owned by:
Priority: minor Milestone:
Component: docs Version: 1.5.0
Severity: low Keywords:
Cc: Language:
Patch status: Platform: all

Description

I think it would be very helpful to have a script to automatically generate #include dependency graphs for parrot at build. This would be very helpful for new developers for getting an idea of how everything fits together.

One way this might be implemented would be to check to see if graphviz is installed during configure, and then if so, generating the graphs during make once everything has been generated by the build tools. If graphviz is not available, a simple indented text file would be nice.

Any reasons why this is unnecessary or impossible?

Change History

Changed 5 years ago by jrtayloriv

Actually, plaintext/pod would be best, now that I'm thinking about it -- very few people are going to have graphviz installed, and it's not worth the trouble of writing/maintaining code to generate graphviz anyway.

Changed 5 years ago by coke

On Sun, Aug 30, 2009 at 1:51 PM, Parrot<parrot-tickets@lists.parrot.org> wrote:
> #959: Auto-generate #include dependency graphs in docs/ at build.

If we going to do this for documentation, we should also consider it
for the build itself. I believe Andy Lester was looking into the
feasibility of this (though our generated C files probably made that
difficult.)

-- 
Will "Coke" Coleda

Changed 5 years ago by petdance

I figure if we can generate the C files, we can also generate their dependencies at the time of the building of the C files.

This IS still something I would like to do.

Changed 3 years ago by jkeenan

Is anyone willing or able to take this on?

Note: See TracTickets for help on using tickets.