Merge branch 'stable-2.9'
* stable-2.9: Revert "ChangeScreen2: Rename Submit to Merge Change" Consistently refer to "CodeMirror" in documentation Describe basics of side-by-side diff screen in review UI documentation Fix inconsistency in documentation Fix project icon in plugin extensions screenshot
@ -112,7 +112,7 @@ Description values containing spaces should be quoted in single quotes
|
||||
Defaults to MERGE_IF_NECESSARY unless
|
||||
link:config-gerrit.html#repository.name.defaultSubmitType[
|
||||
repository.<name>.defaultSubmitType] is set to a different value.
|
||||
For more details see link:project-setup.html#submit_type[
|
||||
For more details see link:project-configuration.html#submit_type[
|
||||
Submit Types].
|
||||
|
||||
--use-content-merge::
|
||||
@ -199,7 +199,7 @@ for remote repository creation.
|
||||
|
||||
== SEE ALSO
|
||||
|
||||
* link:project-setup.html[Project Setup]
|
||||
* link:project-configuration.html[Project Configuration]
|
||||
|
||||
GERRIT
|
||||
------
|
||||
|
@ -57,7 +57,7 @@ Description values containing spaces should be quoted in single quotes
|
||||
|
||||
+
|
||||
For more details see
|
||||
link:project-setup.html#submit_type[Submit Types].
|
||||
link:project-configuration.html#submit_type[Submit Types].
|
||||
|
||||
--content-merge::
|
||||
If enabled, Gerrit will try to perform a 3-way merge of text
|
||||
|
@ -153,7 +153,7 @@ submit settings:
|
||||
- 'mergeContent': Defines whether to automatically merge changes. Valid values
|
||||
are 'true', 'false', or 'INHERIT'. Default is 'INHERIT'.
|
||||
|
||||
- 'action': defines the link:project-setup.html#submit_type[submit type]. Valid
|
||||
- 'action': defines the link:project-configuration.html#submit_type[submit type]. Valid
|
||||
values are 'fast forward only', 'merge if necessary', 'rebase if necessary',
|
||||
'merge always' and 'cherry pick'. The default is 'merge if necessary'.
|
||||
|
||||
|
Before Width: | Height: | Size: 43 KiB After Width: | Height: | Size: 43 KiB |
After Width: | Height: | Size: 120 KiB |
After Width: | Height: | Size: 92 KiB |
After Width: | Height: | Size: 122 KiB |
After Width: | Height: | Size: 121 KiB |
BIN
Documentation/images/user-review-ui-side-by-side-diff-screen.png
Normal file
After Width: | Height: | Size: 118 KiB |
@ -25,7 +25,7 @@
|
||||
.. Patch sets
|
||||
|
||||
== Project Management
|
||||
. link:project-setup.html[Project Setup]
|
||||
. link:project-configuration.html[Project Configuration]
|
||||
. link:access-control.html[Access Controls]
|
||||
.. link:config-labels.html[Review Labels]
|
||||
.. link:config-project-config.html[Access Controls Configuration Format]
|
||||
|
@ -126,7 +126,7 @@ imported.
|
||||
[[project_setup]]
|
||||
== Project Setup
|
||||
|
||||
See link:project-setup.html[Project Setup] for further details on
|
||||
See link:project-configuration.html[Project Configuration] for further details on
|
||||
how to register a new project with Gerrit. This step is necessary
|
||||
if existing Git repositories were not imported during 'init'.
|
||||
|
||||
|
@ -11,7 +11,7 @@ optional elements are moved to pop down boxes.
|
||||
This is not only a facelift. The main highlights are under the hood:
|
||||
|
||||
* Old style RPC calls are replaced by the REST API
|
||||
* The prettify syntax highlighting library was replaced by Codemirror
|
||||
* The prettify syntax highlighting library was replaced by CodeMirror
|
||||
* Automatic refresh of open changes
|
||||
* Support to download a patch direct in browser: no local repo is needed
|
||||
* JS API integration: it was never so easy to add change/revision actions or
|
||||
@ -166,14 +166,14 @@ set is marked on the list in the 'Patch Sets' drop down list. In addition a red
|
||||
"draft" prefix appears on the filenames in the file table.
|
||||
|
||||
[[codemirror]]
|
||||
== Codemirror
|
||||
== CodeMirror
|
||||
|
||||
On the user preferences page, 'Side By Side' or 'Unified Diff' view can be
|
||||
configured. Use the "/" key to start the CodeMirror search, like in 'vim'.
|
||||
|
||||
Key bindings are not customizable at the moment. They may be added in the future.
|
||||
|
||||
Range comments are supported on Codemirror's 'Side By Side' screen. Highlight
|
||||
Range comments are supported on CodeMirror's 'Side By Side' screen. Highlight
|
||||
lines with the mouse and then click the bottom-most line number to create a
|
||||
range comment for the highlighted lines. It can also be used to select a
|
||||
region on one line to emphasize what the comment is related to.
|
||||
@ -184,7 +184,7 @@ Key bindings:
|
||||
* n / p: next diff chunk / previous diff chunk
|
||||
* ] / [: next file / previous file
|
||||
* u: up to change
|
||||
* c: create a new inline comment (focus has to be in codemirror view)
|
||||
* c: create a new inline comment (focus has to be in CodeMirror view)
|
||||
* / or <Ctrl> + f: search in the current file
|
||||
* <Shift> + o: expand or collapse all comments on current line
|
||||
* <Enter> or o: expand or collapse comment
|
||||
@ -294,7 +294,7 @@ The user can now manually toggle the 'reviewed' flag per file using the check
|
||||
box to the left of the filename.
|
||||
|
||||
Key bindings: "j" & "k" to navigate in the file table, "r" to toggle the
|
||||
'reviewed' flag, and "o" or "Enter" to open diff in codemirror or unified diff
|
||||
'reviewed' flag, and "o" or "Enter" to open diff in CodeMirror or unified diff
|
||||
view.
|
||||
|
||||
[[diff-against]]
|
||||
|
@ -209,7 +209,7 @@ verifications from a build server] before changes are merged. In
|
||||
addition you can benefit from Gerrit's merge strategies that can
|
||||
automatically merge/rebase commits on server side if necessary. You can
|
||||
control the merge strategy by configuring the
|
||||
link:project-setup.html#submit_type[submit type] on the project. If you
|
||||
link:project-configuration.html#submit_type[submit type] on the project. If you
|
||||
bypass code review you always need to merge/rebase manually if the tip
|
||||
of the destination branch has moved. Please keep this in mind if you
|
||||
choose to not work with code review because you think it's easier to
|
||||
@ -225,7 +225,7 @@ pushing directly into the repository.
|
||||
|
||||
As project owner you can control several options on your project.
|
||||
The different options are described in the
|
||||
link:project-setup.html#project_options[Project Options] section.
|
||||
link:project-configuration.html#project_options[Project Options] section.
|
||||
|
||||
To see the options of your project
|
||||
|
||||
@ -239,11 +239,11 @@ To see the options of your project
|
||||
|
||||
An important decision for a project is the choice of the submit type
|
||||
and the content merge setting (aka `Automatically resolve conflicts`).
|
||||
The link:project-setup.html#submit_type[submit type] is the method
|
||||
The link:project-configuration.html#submit_type[submit type] is the method
|
||||
Gerrit uses to submit a change to the project. The submit type defines
|
||||
what Gerrit should do on submit of a change if the destination branch
|
||||
has moved while the change was in review. The
|
||||
link:project-setup.html#content_merge[content merge] setting applies
|
||||
link:project-configuration.html#content_merge[content merge] setting applies
|
||||
if the same files have been modified concurrently and tells Gerrit
|
||||
whether it should attempt a content merge for these files.
|
||||
|
||||
@ -252,7 +252,7 @@ weigh development comfort against the safety of not breaking the
|
||||
destination branch.
|
||||
|
||||
The most restrictive submit type is
|
||||
link:project-setup.html#fast_forward_only[Fast Forward Only]. Using
|
||||
link:project-configuration.html#fast_forward_only[Fast Forward Only]. Using
|
||||
this submit type means that after submitting one change all other open
|
||||
changes for the same destination branch must be rebased manually. This
|
||||
is quite burdensome and in practice only feasible for branches with
|
||||
@ -260,7 +260,7 @@ very few changes. On the other hand, if changes are verified before
|
||||
submit, e.g. automatically by a CI integration, with this submit type,
|
||||
you can be sure that the destination branch never gets broken.
|
||||
|
||||
Choosing link:project-setup.html#merge_if_necessary[Merge If Necessary]
|
||||
Choosing link:project-configuration.html#merge_if_necessary[Merge If Necessary]
|
||||
as submit type makes the life for developers more comfortable,
|
||||
especially if content merge is enabled. If this submit strategy is used
|
||||
developers only need to rebase manually if the same files have been
|
||||
@ -281,7 +281,7 @@ link:#prolog-submit-type[Prolog]. This way you can use different submit
|
||||
types for different branches.
|
||||
|
||||
Please note that there are other submit types available; they are
|
||||
described in the link:project-setup.html#submit_type[Submit Type]
|
||||
described in the link:project-configuration.html#submit_type[Submit Type]
|
||||
section.
|
||||
|
||||
[[labels]]
|
||||
@ -400,13 +400,13 @@ capability assigned.
|
||||
|
||||
As project owner you can administrate the branches of your project in
|
||||
the Gerrit Web UI under `Projects` > `List` > <your project> >
|
||||
`Branches`. In the Web UI both link:project-setup.html#branch-creation[
|
||||
branch creation] and link:project-setup.html#branch-deletion[branch
|
||||
`Branches`. In the Web UI both link:project-configuration.html#branch-creation[
|
||||
branch creation] and link:project-configuration.html#branch-deletion[branch
|
||||
deletion] are allowed for project owners without requiring any
|
||||
additional access rights.
|
||||
|
||||
By setting `HEAD` on the project you can define its
|
||||
link:project-setup.html#default-branch[default branch]. For convenience
|
||||
link:project-configuration.html#default-branch[default branch]. For convenience
|
||||
reasons, when the repository is cloned Git creates a local branch for
|
||||
this default branch and checks it out.
|
||||
|
||||
@ -640,7 +640,7 @@ you have the link:access-control.html#capability_createProject[
|
||||
Create Project] global capability assigned.
|
||||
|
||||
Projects can also be created via REST or SSH as described in the
|
||||
link:project-setup.html#project-creation[Project Setup] section.
|
||||
link:project-configuration.html#project-creation[Project Setup] section.
|
||||
|
||||
Creating the project with an initial empty commit is generally
|
||||
recommended because some tools have issues with cloning repositories
|
||||
@ -720,7 +720,7 @@ capabilities is granted, you need to contact a Gerrit administrator to
|
||||
request the deletion of your project.
|
||||
|
||||
Instead of deleting a project you may set the
|
||||
link:project-setup.html#project-state[project state] to `ReadOnly` or
|
||||
link:project-configuration.html#project-state[project state] to `ReadOnly` or
|
||||
`Hidden`.
|
||||
|
||||
[[project-rename]]
|
||||
|
@ -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]
|
||||
|
@ -101,7 +101,7 @@ limitations under the License.
|
||||
</g:Button>
|
||||
|
||||
<g:Button ui:field='submit' styleName='{style.submit}' visible='false'>
|
||||
<div><ui:msg>Merge Change</ui:msg></div>
|
||||
<div><ui:msg>Submit</ui:msg></div>
|
||||
</g:Button>
|
||||
</g:FlowPanel>
|
||||
</ui:UiBinder>
|
||||
|
@ -185,7 +185,7 @@ public class Submit implements RestModifyView<RevisionResource, SubmitInput>,
|
||||
PatchSet.Id current = resource.getChange().currentPatchSetId();
|
||||
return new UiAction.Description()
|
||||
.setTitle(String.format(
|
||||
"Merge patch set %d into %s",
|
||||
"Submit patch set %d into %s",
|
||||
resource.getPatchSet().getPatchSetId(),
|
||||
resource.getChange().getDest().getShortName()))
|
||||
.setVisible(!resource.getPatchSet().isDraft()
|
||||
|