doc/todo/mercurial.mdwn

   1 * Is the code sufficiently robust? It just warns when mercurial fails.
   2 * When rcs_commit is called with a $user that is an openid, it will be
   3   passed through to mercurial -u. Will mercurial choke on this?
   4  * Nope. Mercurial doesn't expect any particular format for the username,
   5    though "Name <address@domain>" is standard. --[[bma]]
   6 * The way `-u $user` is passed to `hg commit`, there's no way to tell
   7   if a given commit came in over the web or was done directly. So
   8   rcs_recentchanges hardcodes 'committype => "mercurial"'. See the monotone
   9   backend for an example of one that does this right.
  10 * The rcs_commit implementation seems not to notice if the file has been
  11   changed since a web edit started. Unlike all the other frontends, which
  12   use the rcstoken to detect if the web commit started editing an earlier
  13   version of the file, and if so, merge the two sets of changes together.
  14   It seems that with the current mercurial commit code, it will always
  15   blindly overwrite the current file with the web edited version, losing
  16   any other changes.
  17
  18 Posthook: in `$srcdir/.hg/hgrc`, I have the following
  19
  20     [hooks]
  21     incoming.update = hg up
  22     update.ikiwiki = ikiwiki --setup /path/to/ikiwiki.setup --refresh
  23
  24 This should update the working directory and run ikiwiki every time a change is recorded (someone who knows mercurial better than I do may be able to suggest a better way, but this works for me.)
  25
  26 > Try running it with --post-commit instead of --refresh. That should
  27 > work better, handling both the case where the edit was made via the web
  28 > and then committed, and the case where a commit was made directly.
  29 > It can deadlock if the post-commit hook runs with --refresh in the
  30 > former case. --[[Joey]]
  31
  32 The problem with --post-commit is that if you delete some pages in $SRC, ikiwiki --setup setupfile --post-commit will not delete them in $DEST.
  33
  34 > You should really be using a setup file that has `mercurial_wrapper`
  35 > set, and running the wrapper generated by that from your hook.
  36 > That will work. I think that the `--setup --post-commit` on the command
  37 > line is currently broken and does the same expensive rebuild process as --setup
  38 > alone (which doesn't delete files from $DEST either). Will fix that.
  39 > --[[Joey]]
  40
  41 I add the following to .hg/hgrc:(I use changegroup since I don't think we need refresh per changeset, please point out if I am wrong.)
  42
  43     [hooks]
  44     changegroup = hg update >&2 && ikiwiki --setup path.to.setup.file --refresh
  45     post-commit = ikiwiki --setup path.to.setup.file --refresh
  46
  47 I tried the follwing commands in $SRC:
  48
  49     touch deadlocktest.mdwn
  50     hg add
  51     hg ci
  52
  53 No deadlock happens.  (Also I push to the $SRC from another machine, again, no deadlock.  If there is conflicts between $SRC and my own repo, hg pull will abort.  You have to pull, merge and push again.)
  54
  55
  56
  57 Of course these tests are too simple.  The problem is I have no idea when the deadlock will happen. If someone is kind enough to point out, I will run more test.
  58
  59 > For the deadlock to occur, a edit has to be made via the web.
  60 >
  61 > Ikiwiki,
  62 > running as a CGI, takes a lock on the wiki, and commits the edit,
  63 > continuing to run in the background, with the lock still held.
  64 > When the edit is committed, the hg hook runs, running `ikwiki --refresh`.
  65 > Nearly the first thing that process does it try to lock the wiki..
  66 > which is already locked. This lock is taken in a blocking manner,
  67 > thus the deadlock -- the cgi is waiting for the commit to finish before
  68 > dropping the lock, and the commit is blocked waiting for the lock to be
  69 > released.
  70 >
  71 > --post-commit avoids this problem by checking if the cgi is running
  72 > and avoiding doing anything in that case. (While still handing the
  73 > refresh if the commit was not made by the CGI.)
  74 > So in that case, the commit finishes w/o ikiwiki doing anything,
  75 > and the ikiwiki CGI handles the wiki refresh.
  76 > --[[Joey]]
  77
  78 ***
  79
  80 I have a few notes on mercurial usage after trying it out for a while:
  81
  82 1. I have been using ikiwiki's `--post-commit` option without apparent problems. I'm the only current user of my wiki, though.
  83
  84 1. The `ikiwiki.setup` file included in ikiwiki works with mercurial's `hgserve`, which is not the preferred solution. Mercurial's `hgwebdir.cgi` is more flexible and doesn't require running a server. I have this in my .setup file:
  85
  86         # Mercurial stuff.
  87         rcs => "mercurial",
  88         historyurl => "http://localhost/cgi-bin/hgwebdir.cgi/ikiwiki/log/tip/\[[file]]",
  89         diffurl => "http://localhost/cgi-bin/hgwebdir.cgi/ikiwiki/diff/tip/\[[file]]",
  90
  91 1. I have noticed that running `ikiwiki` after a change to the wiki adds files to a directory called `recentchanges` under `$srcdir`. I don't understand why such files are needed; worse, they are not added to mercurial's list of tracked files, so they polute the output of `hg log`. Is this a bug? Should mercurial's commit hook be modified to add these files before the commit?
  92
  93 --buo
  94
  95 > No, those files should not be added to revision control. --[[Joey]]
  96
  97 >> OK. I see two problems:
  98
  99 >> 1. If I clone my wiki, I won't get an exact copy of it: I will lose the recentchanges history. This could be an acceptable limitation but IMO this should be documented.
 100
 101 >>> The history is stored in mercurial. How will it be lost?
 102
 103 >> 2. The output of `hg status` is polluted. This could be solved trivially by adding a line containing `recentchanges` to `.hgignore`. Another alternative would be to store the `recentchanges` directory inside `$srdcir/.ikiwiki`.
 104
 105 >> I think the ideal solution would be to build `$destdir/recentchanges/*` directly from the output of `hg log`. --[[buo]]
 106
 107 >>>> That would be 100 times as slow, so I chose not to do that. --[[Joey]]