wishlist

[git.ikiwiki.info.git] / doc / todo / mercurial.mdwn

diff --git a/doc/todo/mercurial.mdwn b/doc/todo/mercurial.mdwn
index e45629102bce5c27678f1f21d79f8a2fa543badb..de1f148e5a030763d1c65b281f6397252aafa206 100644 (file)
--- a/doc/todo/mercurial.mdwn
+++ b/doc/todo/mercurial.mdwn
@@ -14,6 +14,10 @@
   It seems that with the current mercurial commit code, it will always
   blindly overwrite the current file with the web edited version, losing
   any other changes.
   It seems that with the current mercurial commit code, it will always
   blindly overwrite the current file with the web edited version, losing
   any other changes.

+* `rcs_commit_staged`, `rcs_rename`, `rcs_remove`, and `rcs_diff` are not
+  implemented for mercurial, and so attachments, remove and rename plugins
+  and recentchangesdiff cannot be used with it. (These should be fairly
+  easy to add..)

 
 Posthook: in `$srcdir/.hg/hgrc`, I have the following
 
 
 Posthook: in `$srcdir/.hg/hgrc`, I have the following
 


@@ -29,32 +33,41 @@ This should update the working directory and run ikiwiki every time a change is
 > It can deadlock if the post-commit hook runs with --refresh in the
 > former case. --[[Joey]]
 
 > It can deadlock if the post-commit hook runs with --refresh in the
 > former case. --[[Joey]]
 

-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.
+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. --[[users/weakish]]

 
 > You should really be using a setup file that has `mercurial_wrapper`
 > set, and running the wrapper generated by that from your hook.
 > That will work. I think that the `--setup --post-commit` on the command
 > line is currently broken and does the same expensive rebuild process as --setup
 > alone (which doesn't delete files from $DEST either). Will fix that.
 
 > You should really be using a setup file that has `mercurial_wrapper`
 > set, and running the wrapper generated by that from your hook.
 > That will work. I think that the `--setup --post-commit` on the command
 > line is currently broken and does the same expensive rebuild process as --setup
 > alone (which doesn't delete files from $DEST either). Will fix that.

+> (fixed)

 > --[[Joey]] 
 
 > --[[Joey]] 
 

-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.)
+>> Mercurial doesn't support put hooks in .hg/hooks/* (like git). In Mercurial, the only way to run
+>> your own hooks is specifying them in the hgrc file. (Or write a new extension.)
+>> I guess use a very long command will work.
+>> (e.g. ikiwiki --post-commit --a-lot-of-switches --set var=value $SRC $DEST)
+>> (Fortunately ikiwiki supports --set var=value so without --setup works.)
+>>
+>> Alternative is always editing via cgi or pushing.  Never work on the $SRC/repo directly.
+>> --[[users/weakish]]

 
 

-    [hooks]
-    changegroup = hg update >&2 && ikiwiki --setup path.to.setup.file --refresh
-    post-commit = ikiwiki --setup path.to.setup.file --refresh
+>>> I don't see anything preventing you from using a setup file with
+>>> `mercurial_wrapper => ".hg/ikiwiki-hook",` and then modifying the hgrc
+>>> to run that wrapper. --[[Joey]] 

 
 

-I tried the follwing commands in $SRC:
+>> Thanks for pointing out this.  I have some stupid misunderstanding on the
+>> usage of mercurial_wrapper before.  The wrapper works nicely! --[[weakish]]

 
 

-    touch deadlocktest.mdwn
-    hg add
-    hg ci
-
-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.)
+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.)

 
 

+    [hooks]
+    changegroup = hg update >&2 && ikiwiki --setup path.to.setup.file --refresh
+    post-commit = path.to.the.mercurial.wrapper

 
 

+-----

 
 

-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.
+I have no idea when the deadlock will happen.  --[[users/weakish]]

 
 > For the deadlock to occur, a edit has to be made via the web.
 > 
 
 > For the deadlock to occur, a edit has to be made via the web.
 > 


@@ -75,6 +88,7 @@ Of course these tests are too simple.  The problem is I have no idea when the de
 > and the ikiwiki CGI handles the wiki refresh.
 > --[[Joey]]  
 
 > and the ikiwiki CGI handles the wiki refresh.
 > --[[Joey]]  
 

+

 ***
 
 I have a few notes on mercurial usage after trying it out for a while:
 ***
 
 I have a few notes on mercurial usage after trying it out for a while:


@@ -105,3 +119,11 @@ I have a few notes on mercurial usage after trying it out for a while:
 >> I think the ideal solution would be to build `$destdir/recentchanges/*` directly from the output of `hg log`. --[[buo]]
 
 >>>> That would be 100 times as slow, so I chose not to do that. --[[Joey]]
 >> I think the ideal solution would be to build `$destdir/recentchanges/*` directly from the output of `hg log`. --[[buo]]
 
 >>>> That would be 100 times as slow, so I chose not to do that. --[[Joey]]

+
+>>>> Since this is confusing people, allow me to clarify: Ikiwiki's
+>>>> recentchanges generation pulls log information directly out of the VCS as
+>>>> needed. It caches it in recentchanges/* in the `scrdir`. These cache
+>>>> files need not be preserved, should never be checked into VCS, and if
+>>>> you want to you can configure your VCSignore file to ignore them,
+>>>> just as you can configure it to ignore the `.ikiwiki` directory in the
+>>>> `scrdir`. --[[Joey]]