Revision as of 07:00, 10 October 2009

Draft Content
This page is currently under construction. Community members are encouraged to maintain the page, and make sure the information is accurate.

Obtaining Sources

EGit and JGit are currently self hosted in Git. To obtain a copy of each repository:

From the command line:

git clone git://egit.eclipse.org/egit/parallelip-jgit.git jgit
git clone git://egit.eclipse.org/egit/parallelip-egit.git egit

From an installed EGit plugin:

• File > Import > Git Repository
• Enter URL

git://egit.eclipse.org/egit/parallelip-jgit.git

• Import projects

• File > Import > Git Repository
• Enter URL

git://egit.eclipse.org/egit/parallelip-egit.git

• Import projects
• Browse the repositories in gitweb

Contributing Patches

Review the following style guides:

• JGit SUBMITTING_PATCHES
• EGit SUBMITTING_PATCHES

Currently the project is alpha-testing Gerrit Code Review for Git based patch submission and review. To use the alpha testing instance hosted at eclipse.org:

• Register a user account
• Add one or more public SSH keys
• Execute SSH once to accept the host key (or copy it from the registration web page)

ssh -p 29418 username@egit.eclipse.org

• Upload your patch from Git to the target project:
  • JGit

git push ssh://username@egit.eclipse.org:29418/egit/parallelip-jgit.git HEAD:refs/for/master

• • EGit

git push ssh://username@egit.eclipse.org:29418/egit/parallelip-egit.git HEAD:refs/for/master

• Visit our Gerrit Code Review instance to start reviewing

Or, create a new bug and attach a Git formatted patch file, as produced by the `git format-patch` tool.

Adding a remote

Since git can have multiple remotes, you can define one to be used to refer to Gerrit to save typing. Inside a previously checked-out repository you can run:

cd path/to/jgit
git config remote.review.url ssh://username@egit.eclipse.org:29418/egit/parallelip-jgit.git
git config remote.review.push HEAD:refs/for/master

cd path/to/egit
git config remote.review.url ssh://username@egit.eclipse.org:29418/egit/parallelip-egit.git
git config remote.review.push HEAD:refs/for/master

You can now submit review requests from either repository using:

git push review

Gerrit Code Review Cheatsheet

'Install the commit-msg hook in your repository

scp -p -P 29418 username@egit.eclipse.org:hooks/commit-msg .git/hooks

To create a new change

• JGit

git push ssh://username@egit.eclipse.org:29418/egit/parallelip-jgit.git HEAD:refs/for/master

• EGit

git push ssh://username@egit.eclipse.org:29418/egit/parallelip-egit.git HEAD:refs/for/master

Or, if you've followed the instructions on #Adding_a_remote you can simply do:

git push review

Since the current repository has the right definition for 'review', you won't need to remember the canonical push URL

To update an existing change with a new commit

git push ssh://username@egit.eclipse.org:29418/egit/parallelip-jgit.git HEAD:refs/for/master

This works because Gerrit links the new commit to the prior change based upon the Change-Id footer in the commit message. (This is automatically generated by the commit-msg hook you installed above.) If you refuse to use the commit-msg hook, or don't have a Change-Id footer, you should read the Gerrit documentation on change-id lines and replacing changes.

To compare bulk diffs using Git

Since each Gerrit review patchset actually commits its own tree, you can pull out the trees and compare them.

If you've got a large changeset, and you want to be able to do diffs between them via (command line) git instead of browsing on the web, then you can fetch the individual changes and then perform a diff. For example, http://egit.eclipse.org/r/#change,2 shows the 'download' section for each patchset. In this case, it looks like:

• Patch Set 1 git pull git://egit.eclipse.org/egit/parallelip-jgit refs/changes/02/2/1 (1d3331a91bd477d3f70cde9613576cf9688ac358)
• Patch Set 2 git pull git://egit.eclipse.org/egit/parallelip-jgit refs/changes/02/2/2 (13ab9a43d4d512963556a92e889b1204d32f8e68)
• Patch Set 3 git pull git://egit.eclipse.org/egit/parallelip-jgit refs/changes/02/2/3 (d14cc645655683ba3e30a35833fb2282142e898f)
• Patch Set 4 git pull git://egit.eclipse.org/egit/parallelip-jgit refs/changes/02/2/4 (43de8d385b614c72fd796e17da75d381f6e0cc25)

Performing a git pull will both get the bits and merge them into your tree, which won't do what you want for comparison. So, in order to get the bits (but not merge), you need to do a git fetch instead. Let's say we want to diff the last two patches against each other rather than reviewing the entire patchset again:

git fetch git://egit.eclipse.org/egit/parallelip-jgit refs/changes/02/2/3
git fetch git://egit.eclipse.org/egit/parallelip-jgit refs/changes/02/2/4

git diff d14cc645655683ba3e30a35833fb2282142e898f 43de8d385b614c72fd796e17da75d381f6e0cc25

# or git diff d14cc5 43de8d

If you're doing this from within an already checked out project, you can do git fetch origin (or any other remote name in .git/config}.

Git fetched data will stay around in your repository, but will be 'orphaned' if no references point to it. To clean up, you can run git gc or wait until this happens automatically.

To approve a change

• Click on Publish Comments
• Vote with the radio buttons

Code Review

The code review category indicates your opinion on the quality of the code, and how well it fits within the purpose of the existing surrounding code. A +2 vote from any committer is required before submission can occur. A -2 vote from any committer will block submission.

IP Review

The IP review category indicates whether or not the change has been properly logged under the eclipse IP process. Under that process, any committer should mark his/her change +1 if they were the sole author of the change. For any other change, a committer should only mark +1 after ensuring the corresponding bug in Bugzilla has been updated with the iplog flag, or the corresponding CQ has been marked checkintocvs. A +1 vote is required to submit a change, while a -1 vote will block submission.

Libraries from Orbit

com.jcraft.jsch

• File > Import > CVS > Projects from CVS
• Select URL :pserver:anonymous@dev.eclipse.org/cvsroot/tools
• Use module org.eclipse.orbit/com.jcraft.jsch
• Finish
• Right click on the project > Team > Switch to another branch
• Select tag from following list
• Refresh Tags
• Branches > v0_1_41

org.kohsuke.args4j

• File > Import > CVS > Projects from CVS
• Select URL :pserver:anonymous@dev.eclipse.org/cvsroot/tools
• Use module org.eclipse.orbit/org.kohsuke.args4j
• Finish
• Right click on the project > Team > Switch to another branch
• Select tag from following list
• Refresh Tags
• Branches > v2_0_12

javax.servlet

• File > Import > CVS > Projects from CVS
• Select URL :pserver:anonymous@dev.eclipse.org/cvsroot/tools
• Use module org.eclipse.orbit/javax.servlet
• Finish
• Right click on the project > Team > Switch to another branch
• Select tag from following list
• Refresh Tags
• Branches > v2_5_0