ikiwiki/doc/bugs/transitive_dependencies.mdwn

69 lines
2.9 KiB
Plaintext
Raw Normal View History

2009-10-02 21:15:23 +02:00
If a sidebar contains a map, or inline (etc), one would expect a
2009-10-04 22:40:36 +02:00
add/remove of any of the mapped/inlined pages to cause a full wiki
2009-10-02 21:15:23 +02:00
rebuild. But this does not happen.
If page A inlines page B, which inlines page C, a change to C will cause B
to be updated, but A will not "notice" that this means A needs to be
updated.
One way to look at this bug is that it's a bug in where dependencies are
recorded when preprocessing the rendered or sidebar page. The current code
does:
add_depends($params{page}, $somepage);
Where `$params{page}` is page B. If this is changed to `$params{destpage}`,
then the dependency is added to page A, and updates to C cause it to
change. This does result in the page A's getting lots more dependency info
recorded than before (essentially a copy of all the B's dependency info).
It's also a fragile, since all plugins that handle dependencies have to be
changed, and do this going forward. And it seems non-obvious that this should
be done. Or really, whether to use `page` or `destpage` there. Currently,
making the "wrong" choice and using `destpage` instead of `page` (which nearly
everything uses) will just result in semi-redundant dependency info being
recorded. If we make destpage mandatory to fix this, goofing up will lead to
this bug coming back. Ugh.
----
## rebuild = change approach
2009-10-02 21:46:27 +02:00
[[!template id=gitbranch branch=origin/transitive-dependencies author="[[joey]]"]]
Another approach to fix it is to say that anything that causes a
2009-10-02 21:15:23 +02:00
rebuild of B is treated as a change of B. Then when C is changed, B is
rebuilt due to dependencies, and in turn this means A is rebuilt because B
2009-10-02 21:15:23 +02:00
"changed".
This is essentially what is done with wikilinks now, and why, if a sidebar
links to page C, add/remove of C causes all pages to be rebuilt, as seen
here:
removing old page meep
building sidebar.mdwn, which links to meep
building TourBusStop.mdwn, which depends on sidebar
building contact.mdwn, which depends on sidebar
...
Downsides here:
* Means a minimum of 2x as much time spent resolving dependencies,
at least in my simple implementation, which re-runs the dependency
resolution loop until no new pages are rebuilt.
2009-10-02 21:48:47 +02:00
(I added an optimisation that gets it down to 1.5X as much work on
2009-10-04 22:36:39 +02:00
average, still 2x as much worst case. I suppose building a directed
graph and traversing it would be theoretically more efficient.)
* Causes extra work for some transitive dependencies that we don't
2009-10-04 22:40:36 +02:00
actually care about. This is amelorated, but not solved by
the current work on [[todo/dependency_types]].
For example, changing index causes
plugins/brokenlinks to update in the first pass; if there's a second
2009-10-04 22:40:36 +02:00
pass, plugins/map is no longer updated (contentless dependencies FTW),
but plugins is, because it depends on plugins/brokenlinks.
(Of course, this is just a special case of the issue that a real
2009-10-04 22:40:36 +02:00
modification to plugins/brokenlinks causes an unnecessary update of
plugins, and could be solved by adding more dependency types.)
2009-10-02 21:15:23 +02:00
--[[Joey]]