opendev/gerrit
Code Issues Proposed changes

Update document to add content of file comment.

Browse Source 
Change-Id: I9366263033b1865cdede75c95b08c78dcb8c44fe
This commit is contained in:
Bruce Zu 2012-10-25 16:52:00 +08:00
parent 412357d98b
commit 6b0fd7650f
4 changed files with 18 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Documentation/cmd-query.txt
View File

@ -72,7 +72,7 @@ OPTIONS
--comments:: --comments::
Include comments for all changes. If combined with the 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. each patch set.
--commit-message:: --commit-message::

16
Documentation/dev-design.txt
View File

@ -8,7 +8,7 @@ Gerrit is a web based code review system, facilitating online code
reviews for projects using the Git version control system. reviews for projects using the Git version control system.
Gerrit makes reviews easier by showing changes in a side-by-side 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 Gerrit simplifies Git based project maintainership by permitting
any authorized user to submit changes to the master Git repository, 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. permissions in the project.
Reviewers use the web interface to read the side-by-side or unified Reviewers use the web interface to read the side-by-side or unified
diff of a change, and insert draft inline comments where appropriate. diff of a change, and insert draft inline/file comments where
A draft comment is visible only to the reviewer, until they publish appropriate. A draft comment is visible only to the reviewer, until
those comments. Published comments are automatically emailed to they publish those comments. Published comments are automatically
the change author by Gerrit, and are CC'd to all other reviewers emailed to the change author by Gerrit, and are CC'd to all other
who have already commented on the change. reviewers who have already commented on the change.
When publishing comments reviewers are also given the opportunity When publishing comments reviewers are also given the opportunity
to score the change, indicating whether they feel the change is 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 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 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 modified by the change, and `C` is the number of inline/file comments
by the reviewer per file. The constant 4 accounts for the request 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 load the reviewer's dashboard, to load the change detail page,
to publish the review comments, and to reload the change detail to publish the review comments, and to reload the change detail
page after comments are published. page after comments are published.

10
Documentation/intro-quick.txt
View File

@ -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 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 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 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 these views you can add inline comments by double clicking on the line
single click the line number) that you want to comment on. Once (or single click the line number) that you want to comment on. Also you
published these comments are viewable to all, allowing discussion can add file comment by double clicking anywhere (not just on the
of the change to take place. "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 .Side By Side Patch View
image::images/intro-quick-review-line-comment.jpg[Adding a Comment] image::images/intro-quick-review-line-comment.jpg[Adding a Comment]

6
Documentation/json.txt
View File

@ -51,7 +51,7 @@ status:: Current state of this change.
ABANDONED;; Change was abandoned by its owner or administrator. ABANDONED;; Change was abandoned by its owner or administrator.
comments:: All comments for this change in <<message,message attributes>>. comments:: All inline/file comments for this change in <<message,message attributes>>.
trackingIds:: Issue tracking system links in trackingIds:: Issue tracking system links in
<<trackingid,trackingid attributes>>, scraped out of the commit <<trackingid,trackingid attributes>>, scraped out of the commit
@ -114,7 +114,7 @@ was created.
approvals:: The <<approval,approval attribute>> granted. approvals:: The <<approval,approval attribute>> granted.
comments:: All inline comments for this patchset in <<patchsetcomment,patchsetComment attributes>>. comments:: All comments for this patchset in <<patchsetcomment,patchsetComment attributes>>.
files:: All changed files in this patchset in <<patch,patch attributes>>. files:: All changed files in this patchset in <<patch,patch attributes>>.
@ -232,7 +232,7 @@ message:: The comment text.
[[patchsetcomment]] [[patchsetcomment]]
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. file:: The name of the file on which the comment was added.