darcs

Issue 980 documentation: tree hierarchy of general behaviour parts

Title documentation: tree hierarchy of general behaviour parts
Priority bug Status wont-fix
Milestone Resolved in
Superseder Nosy List darcs-devel, dmitry.kurochkin, gwern, kowey, thorkilnaur, tommy
Assigned To
Topics Devel, Documentation

Created on 2008-08-07.18:24:15 by kowey, last changed 2009-08-27.14:33:47 by admin.

Messages
msg5330 (view) Author: kowey Date: 2008-08-07.18:24:11
Chile`: kowey: just a general hacking request, but its amazingly helpful to have
a tree heirarchy of parts/behaviors/functions along with where specifically
they're implemented & maybe briefly what other parts they touch

Chile`: kowey: the big hurdle is getting familiar with the code base, which
isn't worth it for most people for a patch or two, especially if they're not
sure what mucking with one thing will do to another
msg5331 (view) Author: simon Date: 2008-08-07.18:51:40
Very true. Using my time machine, I've made a start on this. Please give
tools/index.hs and make overview from
http://article.gmane.org/gmane.comp.version-control.darcs.user/12731 a try.
msg8492 (view) Author: kowey Date: 2009-08-25.19:08:52
Simon's tools/index.html and make overview are now gone, but I'm not sure that
an automated solution to this request is even possible.

We've started collecting stuff here http://wiki.darcs.net/DarcsInternals and we
now have haddock at http://darcs.net

What else can we do?

I think I'm going to wont-fix this unless somebody can shed light on the request
or take charge of the code documentation initiative :-(
msg8518 (view) Author: simon Date: 2009-08-26.16:37:08
graphtype has just been released; it generates nice diagrams of types. It worked 
well on smaller programs I tried, but fails to parse something in the darcs 
source. If that could be worked around, it would probably generate valuable 
visualisations.
msg8521 (view) Author: gwern Date: 2009-08-26.21:25:25
It seems to choke on CPP flags; specifically, 
[05:16 PM] 0Mb$ graphtype `find . -name "*.lhs"` `find . -name "*.hs"`
./src/unit.lhs: 74: 1
Parse error: VarSym "#"

(Which seems to be due to '#include impossible.h')

As it uses haskell-src-exts, and hlint uses haskell-src-exts but handles CPP
fine, I think this is just a bug in graphtype. Has anyone contacted the author?
History
Date User Action Args
2008-08-07 18:24:15koweycreate
2008-08-07 18:51:46simonsetstatus: unread -> testing
nosy: + simon
messages: + msg5331
2008-08-22 02:24:11koweysetpriority: urgent -> bug
nosy: tommy, beschmi, kowey, dagit, simon
2009-08-06 21:10:20adminsetnosy: + dmitry.kurochkin, thorkilnaur, - beschmi
2009-08-11 00:19:47adminsetnosy: - dagit
2009-08-11 00:52:29koweysettopic: + Documentation, Devel
nosy: tommy, kowey, simon, thorkilnaur, dmitry.kurochkin
2009-08-25 17:23:52adminsetnosy: + darcs-devel, - simon
2009-08-25 19:08:55koweysetstatus: testing -> wont-fix
nosy: tommy, kowey, darcs-devel, thorkilnaur, dmitry.kurochkin
messages: + msg8492
2009-08-26 16:37:11simonsetnosy: + simon
messages: + msg8518
2009-08-26 16:49:57simonsetnosy: - simon
2009-08-26 21:25:27gwernsetnosy: + gwern
messages: + msg8521
2009-08-27 14:33:47adminsetnosy: tommy, kowey, darcs-devel, thorkilnaur, gwern, dmitry.kurochkin