Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "EGerrit/User Guide"
| Line 3: | Line 3: | ||
= Getting Started = | = Getting Started = | ||
== Overview == | == Overview == | ||
| − | The EGerrit plug-in aims at deeply integrating the best of Gerrit's features into Eclipse to minimize the context switch from the IDE to the web, and | + | The EGerrit plug-in aims at deeply integrating the best of Gerrit's features into Eclipse to minimize the context switch from the IDE to the web, and leveraging IDE specific features such as syntax coloring, navigation, etc. |
| − | + | ||
| − | * Search | + | Some of the key features are: |
| − | + | * Search and browse reviews | |
| − | * Submit, vote, reviews | + | * Submit, vote, abandon, rebase ... reviews |
| − | * Comment | + | * Comment directly in the source file |
| + | * ... | ||
== Installing EGerrit == | == Installing EGerrit == | ||
EGerrit is tested with the Neon and Mars releases of Eclipse. It is also know to work with Luna but it is not officially tested. | EGerrit is tested with the Neon and Mars releases of Eclipse. It is also know to work with Luna but it is not officially tested. | ||
| − | As this point (Nov 2015), EGerrit is not officially released, but you can still try by installing it from our [[EGerrit/p2_repositories|milestone site]]. | + | As this point (Nov 2015), EGerrit is not officially released, but you can still try it by installing it from our [[EGerrit/p2_repositories|milestone site]]. |
== Gerrit Dashboard == | == Gerrit Dashboard == | ||
| + | The Gerrit dashboard view provides a way to search for reviews. | ||
== Review editor == | == Review editor == | ||
| + | The review editor gives access to all the information about the review. | ||
| + | It is organized along 4 main tabs: | ||
| + | * Summary - General information on the review such as the list of reviewers, conflicting reviews, related changes, etc. | ||
| + | * Message - The message of the review, the committer, parent commit id; | ||
| + | * Files - The list of files that have changed; | ||
| + | * History - The history of the review. | ||
== Commenting in a file == | == Commenting in a file == | ||
| − | EGerrit supports the addition of comments directly from the compare editor. | + | EGerrit supports the addition of comments directly from the compare editor. |
| + | Once the review editor is opened, go to the "files tab" and select the file you want to compare. | ||
| + | Once in the compare editor, simply start typing comment in the file. | ||
Revision as of 13:54, 23 October 2015
| EGerrit | |
| Website | |
| Download | |
| Community | |
| Mailing List • Forums • IRC • mattermost | |
| Issues | |
| Open • Help Wanted • Bug Day | |
| Contribute | |
| Browse Source |
Contents
Getting Started
Overview
The EGerrit plug-in aims at deeply integrating the best of Gerrit's features into Eclipse to minimize the context switch from the IDE to the web, and leveraging IDE specific features such as syntax coloring, navigation, etc.
Some of the key features are:
- Search and browse reviews
- Submit, vote, abandon, rebase ... reviews
- Comment directly in the source file
- ...
Installing EGerrit
EGerrit is tested with the Neon and Mars releases of Eclipse. It is also know to work with Luna but it is not officially tested.
As this point (Nov 2015), EGerrit is not officially released, but you can still try it by installing it from our milestone site.
Gerrit Dashboard
The Gerrit dashboard view provides a way to search for reviews.
Review editor
The review editor gives access to all the information about the review. It is organized along 4 main tabs:
- Summary - General information on the review such as the list of reviewers, conflicting reviews, related changes, etc.
- Message - The message of the review, the committer, parent commit id;
- Files - The list of files that have changed;
- History - The history of the review.
Commenting in a file
EGerrit supports the addition of comments directly from the compare editor. Once the review editor is opened, go to the "files tab" and select the file you want to compare. Once in the compare editor, simply start typing comment in the file.