README

   1          Gerrit review's comments preparation helper (Herr Vim)
   2
   3 Gerrit (https://www.gerritcodereview.com/) code review system by default
   4 has Web-based interface for creating comments for review. It requires to
   5 be online, with enabled JavaScript. It does not play well with some
   6 browsers that captures keystrokes. IT has no ability to change interface
   7 to something more convenient and comfortable to work with.
   8
   9 Fortunately it has some API that provides ability to post bunch of
  10 comments for review in JSON format and you can use it to publish
  11 comments created with convenient offline tools.
  12
  13 This Vim plugin is intended to be Web-interface replacement for review
  14 creation process. It uses Vim with Fugitive plugin to create a temporary
  15 file (gerrvim.txt) with aggregated comments. Then this gerrvim.txt file
  16 is converted to JSON suitable to be posted to Gerrit like this (or use
  17 REST-API interface):
  18
  19     gerrvim2json.pl /tmp/gerrvim.txt | ssh gerrit gerrit review --json
  20
  21 It allows creation of multiline optional review message and comments for
  22 line ranges inside files.
  23
  24 Installation instruction is in INSTALL.
  25 Format of the temporary gerrvim.txt file is described in gerrvim2json.pl.
  26
  27 gerrvim is free software: see the file COPYING for copying conditions.