Skip to content
  • Jakub Narębski's avatar
    gitweb: Incremental blame (using JavaScript) · 4af819d4
    Jakub Narębski authored and Junio C Hamano's avatar Junio C Hamano committed
    
    
    Add 'blame_incremental' view, which uses "git blame --incremental"
    and JavaScript (Ajax), where 'blame' use "git blame --porcelain".
    
     * gitweb generates initial info by putting file contents (from
       "git cat-file") together with line numbers in blame table
     * then gitweb makes web browser JavaScript engine call startBlame()
       function from gitweb.js
     * startBlame() opens XMLHttpRequest connection to 'blame_data' view,
       which in turn calls "git blame --incremental" for a file, and
       streams output of git-blame to JavaScript (gitweb.js)
     * XMLHttpRequest event handler updates line info in blame view as soon
       as it gets data from 'blame_data' (from server), and it also updates
       progress info
     * when 'blame_data' ends, and gitweb.js finishes updating line info,
       it fixes colors to match (as far as possible) ordinary 'blame' view,
       and updates information about how long it took to generate page.
    
    Gitweb deals with streamed 'blame_data' server errors by displaying
    them in the progress info area (just in case).
    
    The 'blame_incremental' view tries to be equivalent to 'blame' action;
    there are however a few differences in output between 'blame' and
    'blame_incremental' view:
    
     * 'blame_incremental' always used query form for this part of link(s)
       which is generated by JavaScript code.  The difference is visible
       if we use path_info link (pass some or all arguments in path_info).
       Changing this would require implementing something akin to href()
       subroutine from gitweb.perl in JavaScript (in gitweb.js).
     * 'blame_incremental' always uses "rowspan" attribute, even if
       rowspan="1".  This simplifies code, and is not visible to user.
     * The progress bar and progress info are still there even after
       JavaScript part of 'blame_incremental' finishes work.
    
    Note that currently no link generated by gitweb leads to this new view.
    
    This code is based on patch by Petr Baudis <pasky@suse.cz> patch, which
    in turn was tweaked up version of Fredrik Kuivinen <frekui@gmail.com>'s
    proof of concept patch.
    
    This patch adds GITWEB_JS compile configuration option, and modifies
    git-instaweb.sh to take gitweb.js into account.  The code for
    git-instaweb.sh was taken from Pasky's patch.
    
    Signed-off-by: default avatarFredrik Kuivinen <frekui@gmail.com>
    Signed-off-by: default avatarPetr Baudis <pasky@suse.cz>
    Signed-off-by: default avatarJakub Narebski <jnareb@gmail.com>
    Signed-off-by: default avatarJunio C Hamano <gitster@pobox.com>
    4af819d4