documentation merge request
[ikiwiki.git] / doc / todo / document_dependency_influences_in_code.mdwn
1 [[!template id=gitbranch branch=smcv/ready/document-success-reason author="[[smcv]]"
2 browse=http://git.pseudorandom.co.uk/smcv/ikiwiki.git/shortlog/refs/heads/ready/document-success-reason]]
3 [[!tag patch]]
4
5 Whenever I look at dependency calculation, for instance to solve
6 [[bugs/editing gitbranch template is really slow]], it takes me a while to
7 get my head round the concept of influences. The design documentation is
8 in [[todo/dependency_types]], but that takes the form of a long discussion
9 between [[Joey]] and [[Will]], so it's difficult to tell which of the
10 attempts to define influences were incorrect or have been superseded.
11
12 I think it would be valuable to have brief documentation
13 as doc-comments in the source code. My branch adds some;
14 please confirm whether I got it right? :-)
15
16 It would also be great to have a definition of what
17 should or shouldn't be counted as an influence, and which influences
18 should count as static or dynamic, perhaps analogous to
19 [git-annex's design pages](http://git-annex.branchable.com/design/)
20 and linked from the `match_foo` section of [[plugins/write]]. I haven't
21 written this myself because I'm somewhat stuck on the subtlety of what
22 "indirectly influenced" means... --[[smcv]]