Jump to: navigation, search

Difference between revisions of "CDT/git"

< CDT
(Miscellaneous)
(Source Repositories)
(27 intermediate revisions by 6 users not shown)
Line 5: Line 5:
 
== Source Repositories  ==
 
== Source Repositories  ==
  
CDT is now broken into two git repos. You can view repos at http://git.eclipse.org/c/.
+
You can view all the Eclipse Git repos at http://git.eclipse.org/c/
Core cdt org.eclipse.cdt.git, EDC repo is org.eclipse.cdt.edc.git. If you want to practice there are also
+
test repos, test3/*...
+
  
 
Committers will want to access the master repository via ssh  
 
Committers will want to access the master repository via ssh  
Line 13: Line 11:
 
   ssh://userid@git.eclipse.org/gitroot/cdt/org.eclipse.cdt.git
 
   ssh://userid@git.eclipse.org/gitroot/cdt/org.eclipse.cdt.git
  
where "userid" is your Commiter login name (what you used with CVS and what you use with My Foundation Portal).  
+
where "userid" is your commiter login name (what you use with My Foundation Portal).  
  
Everyone else will use either of the following URLs  
+
Everyone else will use either of the following URLs (Note: these URLs should only be used in Git, not in a Web browser).
  
 
   git://git.eclipse.org/gitroot/cdt/org.eclipse.cdt.git
 
   git://git.eclipse.org/gitroot/cdt/org.eclipse.cdt.git
Line 38: Line 36:
  
 
* Eclipse Setup
 
* Eclipse Setup
** Eclipse Classic 3.8 or 4.2
+
** Get the latest Eclipse Classic (current 4.2.2) from http://www.eclipse.org/downloads
** Install Cdt on top on eclipse or install a separate copy of CDT 8.0 to establish an API baseline. See [[CDT/policy#Using_API_Tooling]]
+
** Install Cdt on top on eclipse or install a separate copy of CDT 8.1 to establish an API baseline. See [[CDT/policy#Using_API_Tooling]]
 
** In Preferences set API baseline (you can set it to its own installation if it has CDT in it)
 
** In Preferences set API baseline (you can set it to its own installation if it has CDT in it)
** Install Egit 1.0 (you can get it from Indigo update site). See docs http://wiki.eclipse.org/EGit/User_Guide
+
** Install Egit 1.0 (you can get it from Juno update site). See docs http://wiki.eclipse.org/EGit/User_Guide
** (Optional) If you are using CDT remote launch: Install Remote System Explorer Run-time for build dependencies
+
** Install PDE/API Tools Environment Descriptions from update site http://download.eclipse.org/eclipse/updates/3.8 (see [https://bugs.eclipse.org/361660 Bug 361660])
** Install PDE/API Tools Environment Descriptions from update site http://download.eclipse.org/eclipse/updates/3.8milestones (see [https://bugs.eclipse.org/361660 Bug 361660])
+
** (Optional) If you are building the CDT remote launch plug-in: Install Remote System Explorer End-User Run-time from Juno update site (under General Purpose Tools)
 +
** (Optional) If you are building the various lrparser and UPCparser plug-ins: Get the Binary Download from http://grepcode.com/snapshot/repository.grepcode.com/java/eclipse.org/3.5/net.sourceforge.lpg/lpgjavaruntime/1.1.0 and copy it into your Eclipse dropins folder
 
* Check out build dependencies
 
* Check out build dependencies
** (Optional) If you are using lp-parsers: from anonymous@dev.eclipse.org:/cvsroot/tools, org.eclipse.orbit, checkout the 1.1 version of net.sourceforge.lpg.lpgjavaruntime
+
** (Optional) If you are building the DSF test plugin, clone the git repo http://git.eclipse.org/c/platform/eclipse.platform.releng.git/ and import the project org.eclipse.test.performance into your workspace
** (Optional) If you are using test plugins: anonymous@dev.eclipse.org:/cvsroot/eclipse, checkout the following
+
*** org.eclipse.test.performance
+
 
* Setup Git credentials
 
* Setup Git credentials
 
** eGit wiki says that it would pop-up dialog for e-mail and name of committer. I did not see it. You have to set it up manually if you did not see the dialog
 
** eGit wiki says that it would pop-up dialog for e-mail and name of committer. I did not see it. You have to set it up manually if you did not see the dialog
Line 66: Line 63:
 
** From the repo, select Import Projects...
 
** From the repo, select Import Projects...
 
*** Select all the projects or individual. Project filter does not seems to work. It maybe easier select all, then close projects you don't need
 
*** Select all the projects or individual. Project filter does not seems to work. It maybe easier select all, then close projects you don't need
 +
*** Here's a list of projects you could start with:
 +
**** org.eclipse.cdt.codan.checkers
 +
**** org.eclipse.cdt.codan.checkers.ui
 +
**** org.eclipse.cdt.codan.core
 +
**** org.eclipse.cdt.codan.core.cxx
 +
**** org.eclipse.cdt.codan.ui
 +
**** org.eclipse.cdt.codan.ui.cfgview
 +
**** org.eclipse.cdt.codan.ui.cxx
 +
**** org.eclipse.cdt.core
 +
**** org.eclipse.cdt.core.linux          (Platform specific, change accordingly)
 +
**** org.eclipse.cdt.core.linux.x86_64  (Platform specific, change accordingly)
 +
**** org.eclipse.cdt.core.win32          (Platform specific, change accordingly)
 +
**** org.eclipse.cdt.core.win32.x86      (Platform specific, change accordingly)
 +
**** org.eclipse.cdt.core.win32.x86_64  (Platform specific, change accordingly)
 +
**** org.eclipse.cdt.debug.core
 +
**** org.eclipse.cdt.debug.mi.core
 +
**** org.eclipse.cdt.debug.mi.ui
 +
**** org.eclipse.cdt.debug.ui
 +
**** org.eclipse.cdt.dsf
 +
**** org.eclipse.cdt.dsf.gdb
 +
**** org.eclipse.cdt.dsf.gdb.ui
 +
**** org.eclipse.cdt.dsf.ui
 +
**** org.eclipse.cdt.gdb
 +
**** org.eclipse.cdt.gdb.ui
 +
**** org.eclipse.cdt.launch
 +
**** org.eclipse.cdt.make.core
 +
**** org.eclipse.cdt.make.ui
 +
**** org.eclipse.cdt.managedbuilder.core
 +
**** org.eclipse.cdt.managedbuilder.gnu.ui
 +
**** org.eclipse.cdt.managedbuilder.ui
 +
**** org.eclipse.cdt.ui
 +
 
** Let the build run. To build properly you should have set API baseline, see comment above about API baseline.
 
** Let the build run. To build properly you should have set API baseline, see comment above about API baseline.
 
* Another video  http://www.youtube.com/user/cdtdoug#p/a/u/1/I5uq6dWdi0w
 
* Another video  http://www.youtube.com/user/cdtdoug#p/a/u/1/I5uq6dWdi0w
Line 75: Line 104:
  
 
There is also wiki for eclipse/git marriage here - http://wiki.eclipse.org/Git
 
There is also wiki for eclipse/git marriage here - http://wiki.eclipse.org/Git
 
=== EDC ===
 
More for EDC soon.
 
  
 
== Setting up SSH keys for committers ==
 
== Setting up SSH keys for committers ==
Line 146: Line 172:
 
== Using Gerrit for CDT  ==
 
== Using Gerrit for CDT  ==
  
'''This section is currently a work in progress'''
+
All changes contributed to CDT by non-committers have to go through Gerrit.  Committers and non-committers must sign the new Eclipse CLA before contributing code. Please refer to the [http://wiki.eclipse.org/CDT/contributing contributing page] on how to sign your CLA.
  
 
Create a Gerrit account:  
 
Create a Gerrit account:  
Line 152: Line 178:
 
#Go to https://git.eclipse.org/r  
 
#Go to https://git.eclipse.org/r  
 
#If you are a committer, click <u>Sign In</u>. You will be asked to upload you SSH public key.  
 
#If you are a committer, click <u>Sign In</u>. You will be asked to upload you SSH public key.  
#If you are not a committer, click <u>Register</u> and create an account.
+
#If you are not a committer, you could use your Bugzilla account or click <u>Register</u> and create an account.
  
 
Setup a Gerrit remote on your local git repo of CDT. Below is the procedure using EGit:  
 
Setup a Gerrit remote on your local git repo of CDT. Below is the procedure using EGit:  
Line 164: Line 190:
  
 
  ssh://&lt;commiterId&gt;@git.eclipse.org:29418/cdt/org.eclipse.cdt.git
 
  ssh://&lt;commiterId&gt;@git.eclipse.org:29418/cdt/org.eclipse.cdt.git
  https://git.eclipse.org/r/p/cdt/org.eclipse.cdt.git
+
  https://git.eclipse.org/r/cdt/org.eclipse.cdt.git
  
 
**In the Ref mapping section, add a RefSpec specification of
 
**In the Ref mapping section, add a RefSpec specification of
Line 172: Line 198:
 
Once you have setup your gerrit remote you should:  
 
Once you have setup your gerrit remote you should:  
  
#Commit the code you want to review to a branch. That branch does not need to be the master branch, but it should have the latest code (rebased to master).  
+
*Commit the code you want to review to a branch. That branch does not need to be the master branch, but it should have the latest code (rebased to master). Make sure that the change description starts with a reference to the bug, e.g. "'''Bug 123456. Fixed an NPE in MyClass.java'''".
#Right-click on the repo in the Git Repositories view and select "Push..."  
+
*When doing the commit, make sure the Gerrit ChangeId is added at the end of the commit comment, to allow to link updated commits to this review.  This is easy to do with EGit: simply press the "Compute ChangeId for Gerrit code review button" when doing your commit, as shown below (don't worry if the change id is all zeros at first, it will get filled in once the commit is done):
#Select the gerrit remote and press Next  
+
<br>
#The push should be from the branch that has the changes towards /refs/for/master. Complete the push.  
+
[[Image:Changeid.png]]
#Go to https://git.eclipse.org/r/#/q/status:open+project:cdt/org.eclipse.cdt,n,z and you should see the change you just pushed (assuming you are watching the CDT project; if not, you can find it in the All section).
+
<br>
 +
*Also make sure to press the Signed-off-by button right next to the ChangeId button.  This is now required by the Eclipse contribution process.  Note that you can set a preference to always add "Signed-off-by" when doing a commit with EGit: ''Window->Preferences->Team->Git->Commit Dialog'' and check ''Insert Signed-off-by''.
 +
*Right-click on the repo in the Git Repositories view and select "Push..."  
 +
*Select the Gerrit remote and press Next  
 +
*The push should be from the branch that has the changes towards refs/for/master. When using HEAD as the source ref, the branch with the change must be checked-out.
 +
*Authorization should be done to complete the push. You should use the committer password using ssh for Gerrit, but when using http from eclipse, you must use a special password that can be found after logging in to Gerrit from the web [https://git.eclipse.org/r/#/settings/http-password here]. Details on the [http://wiki.eclipse.org/Gerrit#Git_over_HTTPS main eclipse gerrit page].
 +
*Go to https://git.eclipse.org/r/#/q/status:open+project:cdt/org.eclipse.cdt,n,z and you should see the change you just pushed (assuming you are watching the CDT project; if not, you can find it in the All section).
  
 
=== Miscellaneous  ===
 
=== Miscellaneous  ===
#Cancelling a review
+
*Automatically insert the changeid for each of your commits
#* If you have submitted a patch set for review but want cancel that submission you should 'Abandon' it.  The 'Abandon' button is only available to the submitter and is located below each patch set entry within the review as shown below:
+
**A changeId in a commit does not have negative impacts but is needed for Gerrit reviews so it is worth always putting one.
<br><br>
+
**Go to Preferences->Team->Git->Configuration
 +
**Choose the tab "Repository Settings"
 +
**Select the repository you want to do this for (in case you have multiple git repositories)
 +
**Press the button "Add Entry..."
 +
**Key: gerrit.createchangeid
 +
**Value: true
 +
*Cancelling a review
 +
** If you have submitted a patch set for review but want cancel that submission you should 'Abandon' it.  The 'Abandon' button is only available to the submitter and is located below each patch set entry within the review as shown below:
 +
<br>
 
[[Image:Abandon.png]]
 
[[Image:Abandon.png]]
 
<br><br>
 
<br><br>
#Un-marking a file that was automatically marked as reviewed  
+
*Un-marking a file that was automatically marked as reviewed  
#*Select the file  
+
**Select the file  
#*Select the 'Preferences' menu at the top of the page  
+
**Select the 'Preferences' menu at the top of the page  
#*The right-most option is 'review'. You can uncheck that.
+
**The right-most option is 'review'. You can uncheck that.
<br><br>
+
<br>
 
[[Image:CDT Gerrit Unreview.png]]
 
[[Image:CDT Gerrit Unreview.png]]
<br><br>
+
<br>
  
 
== Posting patches on Bugzilla ==
 
== Posting patches on Bugzilla ==
  
Until Eclipse provides a Gerrit instance for all projects to use, the mechanism for community contributions remains patches attached to Bugzilla items. So, if you are interested in developing a fix for a particular bug, follow these simple steps:
+
In addition to posting a patch to Gerrit you may also attach it to the bug. Follow these simple steps:
  
 
# Clone the CDT repo as per above if you haven't already done so.
 
# Clone the CDT repo as per above if you haven't already done so.

Revision as of 14:44, 18 September 2013

To make it easier for adoptors and contributors to work with the CDT source, we moved to GIT source control system June 24th 2011. Old CVS repo is read only now.

This document will ultimately be the guide for using git and egit with CDT.

Source Repositories

You can view all the Eclipse Git repos at http://git.eclipse.org/c/

Committers will want to access the master repository via ssh

  ssh://userid@git.eclipse.org/gitroot/cdt/org.eclipse.cdt.git

where "userid" is your commiter login name (what you use with My Foundation Portal).

Everyone else will use either of the following URLs (Note: these URLs should only be used in Git, not in a Web browser).

  git://git.eclipse.org/gitroot/cdt/org.eclipse.cdt.git
  http://git.eclipse.org/gitroot/cdt/org.eclipse.cdt.git

Click here for further information on the Git repos available to CDT developers

Screencasts

Doug Schaefer has posted numerous screencasts on using git with Eclipse

Setting up your workspace with the CDT Repo

Follow these instructions to get working with the CDT repo out on eclipse.org.

Main CDT

  • Eclipse Setup
  • Check out build dependencies
  • Setup Git credentials
    • eGit wiki says that it would pop-up dialog for e-mail and name of committer. I did not see it. You have to set it up manually if you did not see the dialog
    • Windows->Preferences search Git, select Configuration->User Settings
    • Click New Entry... add key[user.name] value[your name]
    • Click New Entry... add key[user.email] value[your committer e-mail]
    • Click ok
  • Clone the repo. See either Doug's video http://www.youtube.com/watch?v=O4rDgx6-B6Q here or instructions below:
    • From the Git perspective, select clone repo action
      • Cut & Paste url below in the first page of wizard for cloning
      • Enter your committer credentials or anonymous (for permanent credentials use ssh keys see below).
      • It will ask you what branches to import. If you only care about head select master, if you want to work with other branches select a corresponding branch, for example cdt_8_0.
      • Press Next. As location where files are stored select a folder inside your workspaces, for example workspace/cdt-git
      • Press Finish (skip Gerrit page)
      • This should take about 3-5 minutes
    • From the repo, select Import Projects...
      • Select all the projects or individual. Project filter does not seems to work. It maybe easier select all, then close projects you don't need
      • Here's a list of projects you could start with:
        • org.eclipse.cdt.codan.checkers
        • org.eclipse.cdt.codan.checkers.ui
        • org.eclipse.cdt.codan.core
        • org.eclipse.cdt.codan.core.cxx
        • org.eclipse.cdt.codan.ui
        • org.eclipse.cdt.codan.ui.cfgview
        • org.eclipse.cdt.codan.ui.cxx
        • org.eclipse.cdt.core
        • org.eclipse.cdt.core.linux (Platform specific, change accordingly)
        • org.eclipse.cdt.core.linux.x86_64 (Platform specific, change accordingly)
        • org.eclipse.cdt.core.win32 (Platform specific, change accordingly)
        • org.eclipse.cdt.core.win32.x86 (Platform specific, change accordingly)
        • org.eclipse.cdt.core.win32.x86_64 (Platform specific, change accordingly)
        • org.eclipse.cdt.debug.core
        • org.eclipse.cdt.debug.mi.core
        • org.eclipse.cdt.debug.mi.ui
        • org.eclipse.cdt.debug.ui
        • org.eclipse.cdt.dsf
        • org.eclipse.cdt.dsf.gdb
        • org.eclipse.cdt.dsf.gdb.ui
        • org.eclipse.cdt.dsf.ui
        • org.eclipse.cdt.gdb
        • org.eclipse.cdt.gdb.ui
        • org.eclipse.cdt.launch
        • org.eclipse.cdt.make.core
        • org.eclipse.cdt.make.ui
        • org.eclipse.cdt.managedbuilder.core
        • org.eclipse.cdt.managedbuilder.gnu.ui
        • org.eclipse.cdt.managedbuilder.ui
        • org.eclipse.cdt.ui


And that's it. One way to test you have everything is to try and Export the master feature. That'll give you everything our official builds do.

Please also read CDT/policy if you are new committer or want to contribute to CDT. Also check CDT/contributing wiki on how to contribute a patch.

There is also wiki for eclipse/git marriage here - http://wiki.eclipse.org/Git

Setting up SSH keys for committers

Doug has video about setting up ssh keys http://www.youtube.com/watch?v=WU9xYP_NScQ&feature=related.

  • To make it work first send request to webmaster@eclipse.org and ask for unrestricted shell, they will give you shell for 24 hours.
  • Generate ssh keys using puttygen or ssh-keygen tools (mingw for windows, native for mac and linux)
  • In Windows->Preferences search for SSH and load you key (private one) in the private key list

Upload keys using web page

Manually upload key using shell (you may require to contact admin to get a shell access first)

  • Login to git.eclipse.org using your committer login and password
mkdir .ssh
chmod 700 .ssh
cd .ssh
cat >> authorized_keys #or open in vi
<paste your public key here>
^D
chmod 600 authorized_keys
  • You can use more than one key if you want to login from diffrent hosts (or you can save key on diffrent hosts - up to you)
  • If you do all this stuff eGit won't ask 10 times for your password anymore!

Updating

  • Analog of svn update is git pull, you can use Pull from git repo
  • However it creates spaghetti like history, so if you only apply one bug a time, cleaner "update" is
    • Fetch
    • Rebase
  • Since it is ugly to do two commands instead of one, you can set up Pull to do that instead of Fetch/Merge
    • You need to set branch.autosetuprebase=always and branch.<name>.rebase=true in git configuration to achieve that

Committing to remote repository

  • Checkout the branch you want to commit changes, for example local:master -> remote:master
  • If it is already checked out, try Fetch to make sure it is in sync
  • Apply patch
  • Commit. Specify Author - contributor of the patch, and yourself as Committer
  • Push.
    • If push failed, you may not be having latest version. In this case Rebase to respective remote branch. It will undo your patch, then fetch, then apply your patch.
  • Fetch. This will synchronize your local branch with latest "push" which is kind of stupid because it was your own push that you just did.

In history view you should see

[master][origin/master][HEAD] Bug xxx - your fix

Committing to two branches

Let say we have a patch and we want to commit fix to cdt_8_0 branch and master

  • Make sure you have both branches in your Local branches list
    • If not create another missing one (from respective remote one)
  • Checkout cdt_8_0
  • Fetch
  • Apply patch
  • Commit patch
  • Checkout master
  • Open History view
  • Make sure button "Show all branches" checked
  • Find your commit
  • Right click on it and Select Cherry Pick, that should apply it to master branch
  • Push (make sure both branches are selected in the dialog to push). Both changes would be pushed now.
  • Fetch
  • Checkout cdt_8_0

At the end of this beauty your history view should show

[master][origin/master] Bug xxx - your fix
[cdt_8_0][origin/cdt_8_0][HEAD] Bug xxx - your fix

Using Gerrit for CDT

All changes contributed to CDT by non-committers have to go through Gerrit. Committers and non-committers must sign the new Eclipse CLA before contributing code. Please refer to the contributing page on how to sign your CLA.

Create a Gerrit account:

  1. Go to https://git.eclipse.org/r
  2. If you are a committer, click Sign In. You will be asked to upload you SSH public key.
  3. If you are not a committer, you could use your Bugzilla account or click Register and create an account.

Setup a Gerrit remote on your local git repo of CDT. Below is the procedure using EGit:

  1. Open 'git repositories' view
  2. Expand the repo that corresponds to the CDT repo
  3. Right-click on 'Remotes' and select "Create remote..."
  4. Give it a name like "gerrit_eclipse" and leave "configure push" selected
  5. Click on the 'Change...' button, next to the 'URI' text box
  6. Use one of the following URI, depending on if you are a committer, and/or you have firewall limitation:
ssh://<commiterId>@git.eclipse.org:29418/cdt/org.eclipse.cdt.git
https://git.eclipse.org/r/cdt/org.eclipse.cdt.git
    • In the Ref mapping section, add a RefSpec specification of
HEAD:refs/for/master

Once you have setup your gerrit remote you should:

  • Commit the code you want to review to a branch. That branch does not need to be the master branch, but it should have the latest code (rebased to master). Make sure that the change description starts with a reference to the bug, e.g. "Bug 123456. Fixed an NPE in MyClass.java".
  • When doing the commit, make sure the Gerrit ChangeId is added at the end of the commit comment, to allow to link updated commits to this review. This is easy to do with EGit: simply press the "Compute ChangeId for Gerrit code review button" when doing your commit, as shown below (don't worry if the change id is all zeros at first, it will get filled in once the commit is done):


Changeid.png

  • Also make sure to press the Signed-off-by button right next to the ChangeId button. This is now required by the Eclipse contribution process. Note that you can set a preference to always add "Signed-off-by" when doing a commit with EGit: Window->Preferences->Team->Git->Commit Dialog and check Insert Signed-off-by.
  • Right-click on the repo in the Git Repositories view and select "Push..."
  • Select the Gerrit remote and press Next
  • The push should be from the branch that has the changes towards refs/for/master. When using HEAD as the source ref, the branch with the change must be checked-out.
  • Authorization should be done to complete the push. You should use the committer password using ssh for Gerrit, but when using http from eclipse, you must use a special password that can be found after logging in to Gerrit from the web here. Details on the main eclipse gerrit page.
  • Go to https://git.eclipse.org/r/#/q/status:open+project:cdt/org.eclipse.cdt,n,z and you should see the change you just pushed (assuming you are watching the CDT project; if not, you can find it in the All section).

Miscellaneous

  • Automatically insert the changeid for each of your commits
    • A changeId in a commit does not have negative impacts but is needed for Gerrit reviews so it is worth always putting one.
    • Go to Preferences->Team->Git->Configuration
    • Choose the tab "Repository Settings"
    • Select the repository you want to do this for (in case you have multiple git repositories)
    • Press the button "Add Entry..."
    • Key: gerrit.createchangeid
    • Value: true
  • Cancelling a review
    • If you have submitted a patch set for review but want cancel that submission you should 'Abandon' it. The 'Abandon' button is only available to the submitter and is located below each patch set entry within the review as shown below:


Abandon.png

  • Un-marking a file that was automatically marked as reviewed
    • Select the file
    • Select the 'Preferences' menu at the top of the page
    • The right-most option is 'review'. You can uncheck that.


CDT Gerrit Unreview.png

Posting patches on Bugzilla

In addition to posting a patch to Gerrit you may also attach it to the bug. Follow these simple steps:

  1. Clone the CDT repo as per above if you haven't already done so.
  2. Create a branch for your bug.
  3. Develop the fix. Commit changes to your branch as required. Note that to create a patch, you can only use a single commit; therefore, if you want to make changes after that first commit, you should select the 'Amend previous commit' button, on the right-top side of the commit dialog.
  4. Once your work is stable and ready to go, create the patch. This is easiest done in the History view. Be aware that a patch can only be created for a single commit.
    1. Be sure to be looking at the History of the entire CDT repository (in the Git Repositories view, select the top element of the repo and choose 'Show in -> History')
    2. Select the commit from which you want to create the patch. Probably this is the last on your branch.
      Create patch menu
    3. In the dialog, save the patch to a file.
      Save to a file
    4. Make sure that the option to save in Git format is selected; this is on the next wizard page. This provides more useful context about the patch, including the commit on which it was based.
      Git format
  5. Now, you have a patch file that you can attach to a Bugzilla as before in when CDT was hosted in a CVS repo.