opendev/gerrit
Code Issues Proposed changes

Describe basics of side-by-side diff screen in review UI documentation

Browse Source 
Change-Id: Iedfd06b1d64e67b8ec919ce043185039a904a9db
Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
This commit is contained in:
Edwin Kempin 2014-05-07 14:31:42 +02:00
parent 54275d80bc
commit d38ddf593e
6 changed files with 36 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
Documentation/images/user-review-ui-side-by-side-diff-screen-project-and-file.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 120 KiB

BIN
Documentation/images/user-review-ui-side-by-side-diff-screen-reviewed.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 92 KiB

BIN
Documentation/images/user-review-ui-side-by-side-diff-screen-scrollbar.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 122 KiB

BIN
Documentation/images/user-review-ui-side-by-side-diff-screen-syntax-coloring.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 121 KiB

BIN
Documentation/images/user-review-ui-side-by-side-diff-screen.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 118 KiB

36
Documentation/user-review-ui.txt
View File

@ -689,6 +689,42 @@ image::images/user-review-ui-change-view-preference.png[width=800, link="images/
[WARNING]
The old change screen will be removed in a later version of Gerrit.
[[side-by-side]]
== Side-by-Side Diff Screen
The side-by-side diff screen shows a single patch; the old file version
is displayed on the left side of the screen; the new file version is
displayed on the right side of the screen.
This screen allows to review a patch and to comment on it.
image::images/user-review-ui-side-by-side-diff-screen.png[width=800, link="images/user-review-ui-side-by-side-diff-screen.png"]
In the screen header the project name and the name of the viewed patch
file are shown.
If a Git web browser is configured on the server, the project name and
the file path are displayed as links to the project and the folder in
the Git web browser.
image::images/user-review-ui-side-by-side-diff-screen-project-and-file.png[width=800, link="images/user-review-ui-side-by-side-diff-screen-project-and-file.png"]
The checkbox in front of the project name and the file name allows the
patch to be marked as reviewed.
image::images/user-review-ui-side-by-side-diff-screen-reviewed.png[width=800, link="images/user-review-ui-side-by-side-diff-screen-reviewed.png"]
Syntax coloring is supported for many languages and file types.
image::images/user-review-ui-side-by-side-diff-screen-syntax-coloring.png[width=800, link="images/user-review-ui-side-by-side-diff-screen-syntax-coloring.png"]
The scrollbar shows patch diffs and inline comments as annotations.
This provides a good overview of the lines in the patch that are
relevant for reviewing. By clicking on an annotation one can quickly
navigate to the corresponding line in the patch.
image::images/user-review-ui-side-by-side-diff-screen-scrollbar.png[width=800, link="images/user-review-ui-side-by-side-diff-screen-scrollbar.png"]
GERRIT
------
Part of link:index.html[Gerrit Code Review]