Merge branch 'master' into cvs

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

diff --git a/doc/todo/headless_git_branches.mdwn b/doc/todo/headless_git_branches.mdwn
index 280405730f27bc4be1cba0fded7b511c84aceec6..4dbbc1cc811aae40184df3769c75cdf60566b88e 100644 (file)
--- a/doc/todo/headless_git_branches.mdwn
+++ b/doc/todo/headless_git_branches.mdwn
@@ -14,30 +14,38 @@ Summary: Change three scary loud failure cases related to empty branches into th
 
 [[!tag patch]]
 
 
 [[!tag patch]]
 

+> FWIW, [[The_TOVA_Company]] apparently wants this feature (and I hope
+> I don't mind that I mention they were willing to pay someone for it,
+> but I told them I'd not done any of the work. :) )
+> 
+> Code review follows, per hunk.. --[[Joey]] 
+

 <pre>
 diff --git a/IkiWiki/Plugin/git.pm b/IkiWiki/Plugin/git.pm
 <pre>
 diff --git a/IkiWiki/Plugin/git.pm b/IkiWiki/Plugin/git.pm

-index cf7fbe9..a1b5ed3 100644
+index cf7fbe9..e5bafcf 100644

 --- a/IkiWiki/Plugin/git.pm
 +++ b/IkiWiki/Plugin/git.pm
 --- a/IkiWiki/Plugin/git.pm
 +++ b/IkiWiki/Plugin/git.pm

-@@ -439,17 +439,20 @@ sub git_commit_info ($;$) {
+@@ -439,17 +439,21 @@ sub git_commit_info ($;$) {

  
        my @opts;
        push @opts, "--max-count=$num" if defined $num;
  
        my @opts;
        push @opts, "--max-count=$num" if defined $num;

-+      my @raw_lines;
-+      my @ci;
- 
+-

 -      my @raw_lines = run_or_die('git', 'log', @opts,
 -              '--pretty=raw', '--raw', '--abbrev=40', '--always', '-c',
 -              '-r', $sha1, '--', '.');
 -      my @raw_lines = run_or_die('git', 'log', @opts,
 -              '--pretty=raw', '--raw', '--abbrev=40', '--always', '-c',
 -              '-r', $sha1, '--', '.');

-+      if (-e $config{srcdir} . '/.git/refs/heads/' . $config{gitmaster_branch}) {
-+              @raw_lines = run_or_die('git', 'log', @opts,
-+                      '--pretty=raw', '--raw', '--abbrev=40', '--always', '-c',
-+                      '-r', $sha1, '--', '.');
- 
--      my @ci;
+-
++      my @raw_lines;
+       my @ci;

 -      while (my $parsed = parse_diff_tree(\@raw_lines)) {
 -              push @ci, $parsed;
 -      }
 -      while (my $parsed = parse_diff_tree(\@raw_lines)) {
 -              push @ci, $parsed;
 -      }

++        
++      # Test to see if branch actually exists yet.
++      if (run_or_non('git', 'show-ref', '--quiet', '--verify', '--', 'refs/heads/' . $config{gitmaster_branch}) ) {
++              @raw_lines = run_or_die('git', 'log', @opts,
++                      '--pretty=raw', '--raw', '--abbrev=40', '--always', '-c',
++                      '-r', $sha1, '--', '.');
++

 +              while (my $parsed = parse_diff_tree(\@raw_lines)) {
 +                      push @ci, $parsed;
 +              }
 +              while (my $parsed = parse_diff_tree(\@raw_lines)) {
 +                      push @ci, $parsed;
 +              }


@@ -48,19 +56,44 @@ index cf7fbe9..a1b5ed3 100644
  
        return wantarray ? @ci : $ci[0];
  }
  
        return wantarray ? @ci : $ci[0];
  }

-@@ -474,7 +477,10 @@ sub rcs_update () {
+</pre>
+
+My concern is that this adds a bit of slowdown (git show-ref is fast, but
+It's still extra work) to a very hot code path that is run to eg,
+update recentchanges after every change. 
+
+Seems not ideal to do extra work every time to handle a case
+that will liternally happen a maximum of once in the entire lifecycle of a
+wiki (and zero times more typically, since the setup automator puts in a
+.gitignore file that works around this problem).
+
+So as to not just say "no" ... what if it always tried to run git log,
+and if it failed (or returned no parsed lines, then it could look 
+at git show-ref to desice whether to throw an error or not.
+--[[Joey]] 
+
+<pre>
+@@ -474,7 +478,10 @@ sub rcs_update () {

        # Update working directory.
  
        if (length $config{gitorigin_branch}) {
 -              run_or_cry('git', 'pull', '--prune', $config{gitorigin_branch});
 +              run_or_cry('git', 'fetch', '--prune', $config{gitorigin_branch});
        # Update working directory.
  
        if (length $config{gitorigin_branch}) {
 -              run_or_cry('git', 'pull', '--prune', $config{gitorigin_branch});
 +              run_or_cry('git', 'fetch', '--prune', $config{gitorigin_branch});

-+              if (-e $config{srcdir} . '/.git/refs/remotes/' . $config{gitorigin_branch} . '/' . $config{gitmaster_branch}) {
++              if (run_or_non('git', 'show-ref', '--quiet', '--verify', '--', 'refs/remotes/' . $config{gitorigin_branch} . '/' . $config{gitmaster_branch}) ) {

 +                      run_or_cry('git', 'merge', $config{gitorigin_branch} . '/' . $config{gitmaster_branch});
 +              }
        }
  }
 +                      run_or_cry('git', 'merge', $config{gitorigin_branch} . '/' . $config{gitmaster_branch});
 +              }
        }
  }

- 
-@@ -559,7 +565,7 @@ sub rcs_commit_helper (@) {
+</pre>
+
+Same concern here about extra work. Code path is nearly as hot, being
+called on every refresh. Probably could be dealt with similarly as above.
+
+Also, is there any point in breaking the pull up into a
+fetch followed by a merge? --[[Joey]] 
+
+<pre>
+@@ -559,7 +566,7 @@ sub rcs_commit_helper (@) {

        # So we should ignore its exit status (hence run_or_non).
        if (run_or_non('git', 'commit', '-m', $params{message}, '-q', @opts)) {
                if (length $config{gitorigin_branch}) {
        # So we should ignore its exit status (hence run_or_non).
        if (run_or_non('git', 'commit', '-m', $params{message}, '-q', @opts)) {
                if (length $config{gitorigin_branch}) {


@@ -70,3 +103,5 @@ index cf7fbe9..a1b5ed3 100644
        }
        
 </pre>
        }
        
 </pre>

+
+This seems fine to apply. --[[Joey]]