po/todo: drop a note about my meta-po branch

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

diff --git a/doc/todo/darcs.mdwn b/doc/todo/darcs.mdwn
index 84c99dabae0c4801cca429f5f1e44e1b160f4ddd..882a41379dde48ebebc2dbb4f3c4b524521a4ae1 100644 (file)
--- a/doc/todo/darcs.mdwn
+++ b/doc/todo/darcs.mdwn
@@ -9,8 +9,8 @@ Here's Thomas Schwinge unfinished darcs support for ikiwiki.
 
 -- [Thomas Schwinge](mailto:tschwinge@gnu.org)
 
 
 -- [Thomas Schwinge](mailto:tschwinge@gnu.org)
 

-[[toggle text="show"]]
-[[toggleable text="""
+[[!toggle text="show"]]
+[[!toggleable text="""

        # Support for the darcs rcs, <URL:http://darcs.net/>.
        # Copyright (C) 2006  Thomas Schwinge <tschwinge@gnu.org>
        #
        # Support for the darcs rcs, <URL:http://darcs.net/>.
        # Copyright (C) 2006  Thomas Schwinge <tschwinge@gnu.org>
        #


@@ -206,8 +206,8 @@ This is my ([bma](bma@bmalee.eu)) darcs.pm - it's messy (my Perl isn't up to muc
 
 `rcs_commit()` uses backticks instead of `system()`, to prevent darcs' output being sent to the browser and mucking with the HTTP headers (`darcs record` has no --quiet option). And `rcs_recentchanges()` uses regexes rather than parsing darcs' XML output.
 
 
 `rcs_commit()` uses backticks instead of `system()`, to prevent darcs' output being sent to the browser and mucking with the HTTP headers (`darcs record` has no --quiet option). And `rcs_recentchanges()` uses regexes rather than parsing darcs' XML output.
 

-[[toggle text="show" id="bma"]]
-[[toggleable id="bma" text="""
+[[!toggle text="show" id="bma"]]
+[[!toggleable id="bma" text="""

 
        #!/usr/bin/perl
        
 
        #!/usr/bin/perl
        


@@ -219,14 +219,14 @@ This is my ([bma](bma@bmalee.eu)) darcs.pm - it's messy (my Perl isn't up to muc
        
        package IkiWiki;
        
        
        package IkiWiki;
        

-       sub rcs_update () { #{{{
+       sub rcs_update () {

                # Do nothing - there's nowhere to update *from*.
                # Do nothing - there's nowhere to update *from*.

-       } #}}}
+       }

        
        

-       sub rcs_prepedit ($) { #{{{
-       } #}}}
+       sub rcs_prepedit ($) {
+       }

        
        

-       sub rcs_commit ($$$;$$) { #{{{
+       sub rcs_commit ($$$;$$) {

                my ($file, $message, $rcstoken, $user, $ipaddr) = @_;
        
                # $user should probably be a name and an email address, by darcs
                my ($file, $message, $rcstoken, $user, $ipaddr) = @_;
        
                # $user should probably be a name and an email address, by darcs


@@ -257,16 +257,16 @@ This is my ([bma](bma@bmalee.eu)) darcs.pm - it's messy (my Perl isn't up to muc
        
                return undef; # success
                
        
                return undef; # success
                

-       sub rcs_add ($) { # {{{
+       sub rcs_add ($) {

                my ($file) = @_;
        
                my @cmdline = ("darcs", "add", "--repodir", "$config{srcdir}", "-a", "-q", "$file");
                if (system(@cmdline) != 0) {
                        warn "'@cmdline' failed: $!";
                }
                my ($file) = @_;
        
                my @cmdline = ("darcs", "add", "--repodir", "$config{srcdir}", "-a", "-q", "$file");
                if (system(@cmdline) != 0) {
                        warn "'@cmdline' failed: $!";
                }

-       } #}}}
+       }

        
        

-       sub rcs_recentchanges ($) { #{{{
+       sub rcs_recentchanges ($) {

                # TODO: This is horrible code. It doesn't work perfectly, and uses regexes
                # rather than parsing Darcs' XML output.
                my $num=shift;
                # TODO: This is horrible code. It doesn't work perfectly, and uses regexes
                # rather than parsing Darcs' XML output.
                my $num=shift;


@@ -314,15 +314,15 @@ This is my ([bma](bma@bmalee.eu)) darcs.pm - it's messy (my Perl isn't up to muc
                                }
                }
                return @ret;
                                }
                }
                return @ret;

-       } #}}}
+       }

        
        

-       sub rcs_notify () { #{{{
+       sub rcs_notify () {

                # TODO
                # TODO

-       } #}}}
+       }

        
        

-       sub rcs_getctime ($) { #{{{
+       sub rcs_getctime ($) {

                error gettext("getctime not implemented");
                error gettext("getctime not implemented");

-       } #}}}
+       }

        
        1
 
        
        1
 


@@ -334,8 +334,8 @@ This is my ([bma](bma@bmalee.eu)) darcs.pm - it's messy (my Perl isn't up to muc
 
 Well, here's my version too. It only does getctime -- using a real XML parser, instead of regexp ugliness -- and maybe recentchanges, but that may be bitrotted, or maybe I never finished it, as I only need the getctime. As for actual commits, I have previously voiced my opinion, that this should be done by the plugin generating a patch bundle, and forwarding it to darcs in some way (`darcs apply` or even email to another host, possibly moderated), instead of the hacky direct modification of a working copy. It could also be faster to getctime in a batch. Just reading in all the changes the first time they're needed, might not be a big improvement in many cases, but if we got a batch request from ikiwiki, we could keep reaing the changes until all the files in this batch request have been met.  --[[tuomov]]
 
 
 Well, here's my version too. It only does getctime -- using a real XML parser, instead of regexp ugliness -- and maybe recentchanges, but that may be bitrotted, or maybe I never finished it, as I only need the getctime. As for actual commits, I have previously voiced my opinion, that this should be done by the plugin generating a patch bundle, and forwarding it to darcs in some way (`darcs apply` or even email to another host, possibly moderated), instead of the hacky direct modification of a working copy. It could also be faster to getctime in a batch. Just reading in all the changes the first time they're needed, might not be a big improvement in many cases, but if we got a batch request from ikiwiki, we could keep reaing the changes until all the files in this batch request have been met.  --[[tuomov]]
 

-[[toggle text="show" id="tuomov"]]
-[[toggleable id="tuomov" text="""
+[[!toggle text="show" id="tuomov"]]
+[[!toggleable id="tuomov" text="""

 <pre>
 #!/usr/bin/perl
 # Stubs for no revision control.
 <pre>
 #!/usr/bin/perl
 # Stubs for no revision control.


@@ -484,4 +484,68 @@ I have addressed the recentchanges bit, you can find my hacked up darcs.pm at <h
 
 It's got couple of FIXMEs, and a very site-specific filter for recentchanges. Not sure how to do that better though. I will eventually add web commits, probably of my own (and mention it here).
 
 
 It's got couple of FIXMEs, and a very site-specific filter for recentchanges. Not sure how to do that better though. I will eventually add web commits, probably of my own (and mention it here).
 

-[[tag patch]]
+---
+
+And here's yet another one, including an updated `ikiwiki-makerepo`. :)
+
+<http://khjk.org/~pesco/ikiwiki-darcs/> (now a darcs repo)
+
+> Note that there's a 'darcs' branch in git that I'm keeping a copy of your
+> code in. Just in case. :-)
+
+I've taken all the good stuff from the above 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`.
+
+Regarding the repository layout: There are two darcs repositories. One is the `srcdir`, the other we'll call `master`.
+
+ *  HTML is generated from `srcdir`.
+ *  CGI edits happen in `srcdir`.
+ *  The backend pulls updates from `master` into `srcdir`, i.e. darcs commits should happen to `master`.
+ *  `master` calls ikiwiki (through a wrapper) in its apply posthook, i.e. `master/_darcs/prefs/defaults` should look like this:
+
+        apply posthook ikiwrap
+        apply run-posthook
+
+    (I'm not sure, should/could it be `ikiwrap --refresh` above?)
+ *  The backend pushes CGI edits from `srcdir` back into `master` (triggering the apply hook).
+ *  The working copies in `srcdir` and `master` should *not* be touched by the user, only by the CGI or darcs, respectively.
+
+> Review of this one:
+> 
+> * Should use tab indentation.
+> * `rcs_getctime` should not need to use a ctime cache (such a cache should 
+>   also not be named `.ikiwiki.ctimes`). `rcs_getctime` is run exactly
+>   once per page, ever, and the data is cached in ikiwiki's index.
+> * I doubt that ENV{DARCS} will be available, since the wrapper clobbers> the entire
+>   environment. I'd say remove that.
+> * I don't understand what `darcs_info` is doing, but it seems to be
+>   parsing xml with a regexp?
+> * Looks like `rcs_commit` needs a few improvements, as marked TODO
+> * `rcs_remove` just calls "rm"? Does darcs record notice the file was removed
+>    and automatically commit the removal? (And why `system("rm")` and not
+>    `unlink`?)
+> * Is the the darcs info in [[details]] still up-to-date re this version?
+> --[[Joey]]
+
+> Update:
+>
+> I think I've addressed all of the above except for the XML parsing in `darcs_info`.
+> The function determines the md5 hash of the last patch the given file appears in.
+> That's indeed being done with regexps but my Perl isn't good enough for a quick recode
+> right now.
+>
+> As for the darcs info in [[rcs/details]], it does not accurately describe the way
+> this version works. It's similar, but the details differ slightly.
+> You could copy my description above to replace it.
+>
+> There is still some ironing to do, for instance the current version doesn't allow for
+> modifying attachments by re-uploading them via CGI ("darcs add failed"). Am I assuming
+> correctly that "adding" a file that's already in the repo should just be a no-op?
+> --pesco
+
+>> It should result in the new file contents being committed by
+>> `rcs_commit_staged`. For some revision control systems, which
+>> automatically commit modifications, it would be a no-op. --[[Joey]]
+
+>>> Done. --pesco
+
+[[!tag patch]]