doc/todo/darcs.mdwn

   1 <http://khjk.org/~pesco/ikiwiki-darcs/> (now a darcs repo)
   2
   3 I've taken all the good stuff from the above (now deleted --[[Joey]]) and added the missing hooks. The code hasn't seen a lot of testing, so some bugs are likely yet to surface. Also, I'm not experienced with perl and don't know where I should have used the function `possibly_foolish_untaint`.
   4
   5 > Review of this one:
   6 >
   7 > * Should use tab indentation. (fixed)
   8 > * `rcs_getctime` should not need to use a ctime cache (such a cache should
   9 >   also not be named `.ikiwiki.ctimes`). `rcs_getctime` is run exactly
  10 >   once per page, ever, and the data is cached in ikiwiki's index. (fixed)
  11 > * I doubt that ENV{DARCS} will be available, since the wrapper clobbers> the entire
  12 >   environment. I'd say remove that. (fixed)
  13 > * I don't understand what `darcs_info` is doing, but it seems to be
  14 >   parsing xml with a regexp?
  15 > * Looks like `rcs_commit` needs a few improvements, as marked TODO
  16 > * `rcs_remove` just calls unlink? Does darcs record notice the file was removed
  17 >    and automatically commit the removal?
  18 > * Is the the darcs info in [[rcs/details]] still up-to-date re this version? (fixed)
  19 > --[[Joey]]
  20
  21 > Update:
  22 >
  23 > I think I've addressed all of the above except for the XML parsing in `darcs_info`.
  24 > The function determines the md5 hash of the last patch the given file appears in.
  25 > That's indeed being done with regexps but my Perl isn't good enough for a quick recode
  26 > right now.
  27 >
  28 > As for the darcs info in [[rcs/details]], it does not accurately describe the way
  29 > this version works. It's similar, but the details differ slightly.
  30 > You could copy my description above to replace it.
  31 >
  32 >> done --[[Joey]]
  33 >
  34 > There is still some ironing to do, for instance the current version doesn't allow for
  35 > modifying attachments by re-uploading them via CGI ("darcs add failed"). Am I assuming
  36 > correctly that "adding" a file that's already in the repo should just be a no-op?
  37 > --pesco
  38
  39 >> It should result in the new file contents being committed by
  40 >> `rcs_commit_staged`. For some revision control systems, which
  41 >> automatically commit modifications, it would be a no-op. --[[Joey]]
  42
  43 >>> Done. --pesco
  44
  45 ----
  46
  47 I've finally merged this into ikiwiki master. The plugin looks quite
  48 complete, with only the new `rcs_receive` hook missing, and I
  49 hope it works as good as it looks. :) If anyone wants to work on improving
  50 it, there are some TODOs as mentioned above that could still be improved.
  51 --[[Joey]]
  52
  53 [[!tag patch done]]