From 51bb2cec82aa3cdc55ca657a6425d3887f8adaa4 Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Fri, 27 Apr 2018 12:13:22 -0400 Subject: [PATCH] add more detail to the readme file Change-Id: I7eea82bd6d16ae2f671c41736730242c51e77fb1 Signed-off-by: Doug Hellmann --- README.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.rst b/README.rst index d483325..b60b72d 100644 --- a/README.rst +++ b/README.rst @@ -7,6 +7,16 @@ A git command for fixing nit-picky changes on gerrit reviews. git-nit is a tool that helps grabbing existing reviews on gerrit and layering on a new patch to fix nits. +Normally review comments are left on the patch in the web UI or via +gertty. For really small suggestions, however, it is nicer to just +propose the update either as a new revision of a patch or as a +follow-up patch. git-nit helps you do that by making it easier to grab +the patch being reviewed in a local copy of the repository. It +automates the steps of cloning the repository to a new directory, +configuring git-review, then downloading the patch in +question. Running one command will set you up to help the person whose +code you are reviewing. + Installing ==========