Browse Source

add more detail to the readme file

Change-Id: I7eea82bd6d16ae2f671c41736730242c51e77fb1
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Doug Hellmann 1 year ago
parent
commit
51bb2cec82
1 changed files with 10 additions and 0 deletions
  1. 10
    0
      README.rst

+ 10
- 0
README.rst View File

@@ -7,6 +7,16 @@ A git command for fixing nit-picky changes on gerrit reviews.
7 7
 git-nit is a tool that helps grabbing existing reviews on gerrit and
8 8
 layering on a new patch to fix nits.
9 9
 
10
+Normally review comments are left on the patch in the web UI or via
11
+gertty. For really small suggestions, however, it is nicer to just
12
+propose the update either as a new revision of a patch or as a
13
+follow-up patch. git-nit helps you do that by making it easier to grab
14
+the patch being reviewed in a local copy of the repository. It
15
+automates the steps of cloning the repository to a new directory,
16
+configuring git-review, then downloading the patch in
17
+question. Running one command will set you up to help the person whose
18
+code you are reviewing.
19
+
10 20
 Installing
11 21
 ==========
12 22
 

Loading…
Cancel
Save