From 6b0fd7650f20783cd605d432f9c45afff98105f3 Mon Sep 17 00:00:00 2001 From: Bruce Zu Date: Thu, 25 Oct 2012 16:52:00 +0800 Subject: [PATCH] Update document to add content of file comment. Change-Id: I9366263033b1865cdede75c95b08c78dcb8c44fe --- Documentation/cmd-query.txt | 2 +- Documentation/dev-design.txt | 16 ++++++++-------- Documentation/intro-quick.txt | 10 ++++++---- Documentation/json.txt | 6 +++--- 4 files changed, 18 insertions(+), 16 deletions(-) diff --git a/Documentation/cmd-query.txt b/Documentation/cmd-query.txt index 963d7884ed..bedfc3d954 100644 --- a/Documentation/cmd-query.txt +++ b/Documentation/cmd-query.txt @@ -72,7 +72,7 @@ OPTIONS --comments:: Include comments for all changes. If combined with the - --patch-sets flag then all in-line comments are included for + --patch-sets flag then all inline/file comments are included for each patch set. --commit-message:: diff --git a/Documentation/dev-design.txt b/Documentation/dev-design.txt index ce2868c58e..2e43b9605c 100644 --- a/Documentation/dev-design.txt +++ b/Documentation/dev-design.txt @@ -8,7 +8,7 @@ Gerrit is a web based code review system, facilitating online code reviews for projects using the Git version control system. Gerrit makes reviews easier by showing changes in a side-by-side -display, and allowing inline comments to be added by any reviewer. +display, and allowing inline/file comments to be added by any reviewer. Gerrit simplifies Git based project maintainership by permitting any authorized user to submit changes to the master Git repository, @@ -99,11 +99,11 @@ selected by Gerrit by identifying users who have change approval permissions in the project. Reviewers use the web interface to read the side-by-side or unified -diff of a change, and insert draft inline comments where appropriate. -A draft comment is visible only to the reviewer, until they publish -those comments. Published comments are automatically emailed to -the change author by Gerrit, and are CC'd to all other reviewers -who have already commented on the change. +diff of a change, and insert draft inline/file comments where +appropriate. A draft comment is visible only to the reviewer, until +they publish those comments. Published comments are automatically +emailed to the change author by Gerrit, and are CC'd to all other +reviewers who have already commented on the change. When publishing comments reviewers are also given the opportunity to score the change, indicating whether they feel the change is @@ -553,8 +553,8 @@ CPU Usage - Web UI Gerrit's web UI would require on average `4+F+F*C` HTTP requests to review a change and post comments. Here `F` is the number of files -modified by the change, and `C` is the number of inline comments left -by the reviewer per file. The constant 4 accounts for the request +modified by the change, and `C` is the number of inline/file comments +left by the reviewer per file. The constant 4 accounts for the request to load the reviewer's dashboard, to load the change detail page, to publish the review comments, and to reload the change detail page after comments are published. diff --git a/Documentation/intro-quick.txt b/Documentation/intro-quick.txt index 8253c917ac..873fbadd8b 100644 --- a/Documentation/intro-quick.txt +++ b/Documentation/intro-quick.txt @@ -209,10 +209,12 @@ Since we are the code reviewer, we're going to review the code. To do this we can view it within the Gerrit web interface as either a unified or side-by-side diff by selecting the appropriate option. In the example below we've selected the side-by-side view. In either of -these views you can add comments by double clicking on the line (or -single click the line number) that you want to comment on. Once -published these comments are viewable to all, allowing discussion -of the change to take place. +these views you can add inline comments by double clicking on the line +(or single click the line number) that you want to comment on. Also you +can add file comment by double clicking anywhere (not just on the +"Patch Set" words) in the table header or single clicking on the icon +in the line-number column header. Once published these comments are +viewable to all, allowing discussion of the change to take place. .Side By Side Patch View image::images/intro-quick-review-line-comment.jpg[Adding a Comment] diff --git a/Documentation/json.txt b/Documentation/json.txt index 12e60fc4c1..eb532089e4 100644 --- a/Documentation/json.txt +++ b/Documentation/json.txt @@ -51,7 +51,7 @@ status:: Current state of this change. ABANDONED;; Change was abandoned by its owner or administrator. -comments:: All comments for this change in <>. +comments:: All inline/file comments for this change in <>. trackingIds:: Issue tracking system links in <>, scraped out of the commit @@ -114,7 +114,7 @@ was created. approvals:: The <> granted. -comments:: All inline comments for this patchset in <>. +comments:: All comments for this patchset in <>. files:: All changed files in this patchset in <>. @@ -232,7 +232,7 @@ message:: The comment text. [[patchsetcomment]] patchsetComment --------------- -Comment added inline on a patchset by a reviewer. +Comment added on a patchset by a reviewer. file:: The name of the file on which the comment was added.