vendor/depot_tools/README.git-cl

   1 # git-cl -- a git-command for integrating reviews on Rietveld
   2 # Copyright (C) 2008 Evan Martin <martine@danga.com>
   3
   4 == Background
   5 Rietveld, also known as http://codereview.appspot.com, is a nice tool
   6 for code reviews.  You upload a patch (and some other data) and it lets
   7 others comment on your patch.
   8
   9 For more on how this all works conceptually, please see README.codereview.
  10 The remainder of this document is the nuts and bolts of using git-cl.
  11
  12 == Install
  13 Copy (symlink) it into your path somewhere, along with Rietveld
  14 upload.py.
  15
  16 == Setup
  17 Run this from your git checkout and answer some questions:
  18 $ git cl config
  19
  20 == How to use it
  21 Make a new branch.  Write some code.  Commit it locally.  Send it for
  22 review:
  23 $ git cl upload
  24 By default, it diffs against whatever branch the current branch is
  25 tracking (see "git checkout --track").  An optional last argument is
  26 passed to "git diff", allowing reviews against other heads.
  27
  28 You'll be asked some questions, and the review issue number will be
  29 associated with your current git branch, so subsequent calls to upload
  30 will update that review rather than making a new one.
  31
  32 == git-svn integration
  33 Review looks good?  Commit the code:
  34 $ git cl dcommit
  35 This does a git-svn dcommit, with a twist: all changes in the diff
  36 will be squashed into a single commit, and the description of the commit
  37 is taken directly from the Rietveld description.  This command also accepts
  38 arguments to "git diff", much like upload.
  39 Try "git cl dcommit --help" for more options.
  40
  41 == Extra commands
  42 Print some status info:
  43 $ git cl status
  44
  45 Edit the issue association on the current branch:
  46 $ git cl issue 1234
  47
  48 Patch in a review:
  49 $ git cl patch <url to full patch>
  50 Try "git cl patch --help" for more options.
  51
  52 vim: tw=72 :