ikiwiki (3.20130711) unstable; urgency=low
[ikiwiki.git] / doc / todo / headless_git_branches.mdwn
1 Ikiwiki should really survive being asked to work with a git branch that has no existing commits.
2
3     mkdir iki-gittest
4     cd iki-gittest
5     GIT_DIR=barerepo.git git init
6     git clone barerepo.git srcdir
7     ikiwiki --rcs=git srcdir destdir
8
9 I've fixed this initial construction case, and, based on my testing, I've
10 also fixed the post-update executing on a new master, and ikiwiki.cgi
11 executing on a non-existent master cases.
12
13 Please commit so my users stop whining at me about having clean branches to push to, the big babies.
14
15 Summary: Change three scary loud failure cases related to empty branches into three mostly quiet success cases.
16
17 [[!tag patch]]
18
19 > FWIW, [[The_TOVA_Company]] apparently wants this feature (and I hope
20 > I don't mind that I mention they were willing to pay someone for it,
21 > but I told them I'd not done any of the work. :) )
22
23 > Code review follows, per hunk.. --[[Joey]] 
24
25 <pre>
26 diff --git a/IkiWiki/Plugin/git.pm b/IkiWiki/Plugin/git.pm
27 index cf7fbe9..e5bafcf 100644
28 --- a/IkiWiki/Plugin/git.pm
29 +++ b/IkiWiki/Plugin/git.pm
30 @@ -439,17 +439,21 @@ sub git_commit_info ($;$) {
31  
32         my @opts;
33         push @opts, "--max-count=$num" if defined $num;
34 -
35 -       my @raw_lines = run_or_die('git', 'log', @opts,
36 -               '--pretty=raw', '--raw', '--abbrev=40', '--always', '-c',
37 -               '-r', $sha1, '--', '.');
38 -
39 +       my @raw_lines;
40         my @ci;
41 -       while (my $parsed = parse_diff_tree(\@raw_lines)) {
42 -               push @ci, $parsed;
43 -       }
44 +        
45 +       # Test to see if branch actually exists yet.
46 +       if (run_or_non('git', 'show-ref', '--quiet', '--verify', '--', 'refs/heads/' . $config{gitmaster_branch}) ) {
47 +               @raw_lines = run_or_die('git', 'log', @opts,
48 +                       '--pretty=raw', '--raw', '--abbrev=40', '--always', '-c',
49 +                       '-r', $sha1, '--', '.');
50 +
51 +               while (my $parsed = parse_diff_tree(\@raw_lines)) {
52 +                       push @ci, $parsed;
53 +               }
54  
55 -       warn "Cannot parse commit info for '$sha1' commit" if !@ci;
56 +               warn "Cannot parse commit info for '$sha1' commit" if !@ci;
57 +       };
58  
59         return wantarray ? @ci : $ci[0];
60  }
61 </pre>
62
63 My concern is that this adds a bit of slowdown (git show-ref is fast, but
64 It's still extra work) to a very hot code path that is run to eg,
65 update recentchanges after every change. 
66
67 Seems not ideal to do extra work every time to handle a case
68 that will literally happen a maximum of once in the entire lifecycle of a
69 wiki (and zero times more typically, since the setup automator puts in a
70 .gitignore file that works around this problem).
71
72 So as to not just say "no" ... what if it always tried to run git log,
73 and if it failed (or returned no parsed lines), then it could look 
74 at git show-ref to deduce whether to throw an error or not.
75 --[[Joey]] 
76
77 > Ah, but then git-log would still complain "bad revision 'HEAD'"
78 > --[[Joey]] 
79
80 <pre>
81 @@ -474,7 +478,10 @@ sub rcs_update () {
82         # Update working directory.
83  
84         if (length $config{gitorigin_branch}) {
85 -               run_or_cry('git', 'pull', '--prune', $config{gitorigin_branch});
86 +               run_or_cry('git', 'fetch', '--prune', $config{gitorigin_branch});
87 +               if (run_or_non('git', 'show-ref', '--quiet', '--verify', '--', 'refs/remotes/' . $config{gitorigin_branch} . '/' . $config{gitmaster_branch}) ) {
88 +                       run_or_cry('git', 'merge', $config{gitorigin_branch} . '/' . $config{gitmaster_branch});
89 +               }
90         }
91  }
92
93 </pre>
94
95 Same concern here about extra work. Code path is nearly as hot, being
96 called on every refresh. Probably could be dealt with similarly as above.
97
98 Also, is there any point in breaking the pull up into a
99 fetch followed by a merge? --[[Joey]] 
100
101 <pre>
102 @@ -559,7 +566,7 @@ sub rcs_commit_helper (@) {
103         # So we should ignore its exit status (hence run_or_non).
104         if (run_or_non('git', 'commit', '-m', $params{message}, '-q', @opts)) {
105                 if (length $config{gitorigin_branch}) {
106 -                       run_or_cry('git', 'push', $config{gitorigin_branch});
107 +                       run_or_cry('git', 'push', $config{gitorigin_branch}, $config{gitmaster_branch});
108                 }
109         }
110         
111 </pre>
112
113 This seems fine to apply. --[[Joey]]