Jump to: navigation, search

Difference between revisions of "JDT Core Committer FAQ"

(What target milestone should be used ?)
(Meta FAQ)
Line 9: Line 9:
 
=== How do I contribute to this FAQ ? ===
 
=== How do I contribute to this FAQ ? ===
 
Simply edit this page. You will need to [http://bugs.eclipse.org/bugs/index.cgi?GoAheadAndLogIn=1 log in] using your bugzilla username and password to gain access.  If you don't have a Bugzilla account, you can [http://bugs.eclipse.org/bugs/createaccount.cgi create a new one].
 
Simply edit this page. You will need to [http://bugs.eclipse.org/bugs/index.cgi?GoAheadAndLogIn=1 log in] using your bugzilla username and password to gain access.  If you don't have a Bugzilla account, you can [http://bugs.eclipse.org/bugs/createaccount.cgi create a new one].
 +
 +
=== What should I do after contributing to this FAQ ? ===
 +
You should send a message to jdt-core-dev@eclipse.org with the diff url (e.g. http://wiki.eclipse.org/index.php?title=JDT_Core_Committer_FAQ&diff=50781&oldid=50780) so that every JDT/Core committer is aware of the change.
  
 
== Coding ==
 
== Coding ==

Revision as of 06:59, 18 September 2007

Meta FAQ

Who is this FAQ for ?

This FAQ is for the JDT/Core committers, and anyone who is willing to participate in the development of JDT/Core.

What is this FAQ about ?

This FAQ is about the rules that JDT/Core committers follow when developing the JDT/Core component.

How do I contribute to this FAQ ?

Simply edit this page. You will need to log in using your bugzilla username and password to gain access. If you don't have a Bugzilla account, you can create a new one.

What should I do after contributing to this FAQ ?

You should send a message to jdt-core-dev@eclipse.org with the diff url (e.g. http://wiki.eclipse.org/index.php?title=JDT_Core_Committer_FAQ&diff=50781&oldid=50780) so that every JDT/Core committer is aware of the change.

Coding

Where is the JDT/Core code ?

All the JDT/Core code is in the Eclipse CVS repository. The JDT/Core projects are:

  • org.eclipse.jdt.compiler.tool
  • org.eclipse.jdt.compiler.tool.tests
  • org.eclipse.jdt.core
  • org.eclipse.jdt.core.tests.builder
  • org.eclipse.jdt.core.tests.compiler
  • org.eclipse.jdt.core.tests.model
  • org.eclipse.jdt.core.tests.performance

How do I create a CVS repository connection ?

The following information must be used to create a CVS repository connection:

  • Connection type: extssh (or pserver if you are not yet a committer and don't have an Eclipse account)
  • User: <your id> (or anonymous if you are not yet a committer and don't have an Eclipse account)
  • Password: <your password>
  • Host: dev.eclipse.org
  • Repository path: /cvsroot/eclipse
  • Use default port

What branch should I use ?

  • HEAD: used for the development of the upcoming release. For example, HEAD is currently used for the development of 3.4.
  • R3_x_maintenance: used for the maintenance of a release. For example, R3_3_maintenance is currently used for the development of 3.3.1.

Committing to CVS

How do I maintain the build notes ?

The build notes (in org.eclipse.jdt.core/buildnotes_jdt-core.html) should be updated just before committing a bug fix. This file should be committed at the same time as the bug fix. To update the build notes, use the JDT/Core tool (right click on the file, then JDT Core tools > Add to build note...).

What comment should I associate with a commit ?

The comment of a commit should be of the form: <branch> - <bug number with optional comments>, e.g.

  • HEAD - 1234567
  • R3_3_maintenance - fix for 123678 (with tests)

Bugzilla

What bugs are currently opened against JDT/Core?

Bugs opened and not resolved yet.

What target milestone should be used ?

  1. If the bug is marked as WORKSFORME
    a) if you tested the problem with a pure milestone build, use this milestone (e.g. if you've tested that a problem works with a pure 3.4M1 build, then use 3.4M1)
    b) if you tested the problem with an integration build, use the next milestone (e.g. if you've tested that a problem works with an integration build after 3.4M1, then use 3.4M2)
  2. If the bug is marked as DUPLICATE,
    a) if the original bug has not been fixed yet, don't set the milestone on the duplicate (it will be set when rule 6 is applied)
    b) if the original bug has been fixed, use either rule 1a. or rule 1b.
    c) if the original bug has been set to WONTFIX or INVALID, use next milestone (rule 3).
  3. If the bug is marked WONTFIX or INVALID, use the next milestone (in this case, the target is simply used to identify that the bug has been closed during this specific period...)
  4. If the bug is marked FIXED, use the next milestone (as we always do)
  5. If a bug is backported to a maintenance stream, change the target milestone to the next maintenance release (e.g. if a bug fixed in 3.4M1 is backported to R3_3_maintenance, then change the milestone to 3.3.1)
  6. In all cases, go through the duplicates of the bug being resolved, and set these duplicates with the same milestone as the one used for the bug being resolved

What comment should be used when fixing a bug ?

When changing a bug to RESOLVED/FIXED a comment containing the following string should be use: "released for <target milestone | maintenance release>". E.g.

  • Fixed and released for 3.4M2 in HEAD
  • Released for 3.3.1

This string is used when querying the bugs to verify for a particular milestone.

The resolution LATER is deprecated. What should I use instead ?

Bugs that we don't plan to fix used to be resolved as LATER. Since this resolution is deprecated, we shall now use the P5 priority.

The resolution REMIND is deprecated. What should I use instead?

Bugs that needed more information used to be resolved as REMIND. Since this resolution is deprecated, we shall now use the needinfo keyword.

What status/resolution should I use after marking a bug duplicate?

  • If the original bug is marked RESOLVED/FIXED, leave it to RESOLVED/DUPLICATE
  • If the original bug is marled VERIFIED/FIXED, change it to VERIFIED/DUPLICATE

Release engineering

What steps should I follow to make a build contribution ?

  1. Ensure that you are in sync with the stream (HEAD, R3_x_maintenance, ...) you want to contribute to.
  2. Close the build notes using the JDT/Core tool (right click on the file, then JDT Core tools > Close build notes).
  3. Commit the build notes.
  4. Tag all JDT/Core projects (even those that haven't changed) with the current version (found in the build notes), eg. v_810
  5. If needed, check out org.eclipse.releng from the stream you want to contribute to.
  6. Edit org.eclipse.releng/maps/jdtcore.map:
    1. Change the contribution date
    2. Change all version numbers to the new one
  7. Commit org.eclipse.releng/maps/jdtcore.map
  8. Send a message to the jdt-core-dev mailing list saying that the contribution was made including the version number, e.g. a message with the following title: "Released v_810 for today's integration build" and no body is sufficient.

Misc

How do I get the JDT/Core tools ?

The JDT/Core tool can be obtained from this update site: http://www.eclipse.org/jdt/core/tools/jdtcoretools/update-site/ using Eclipse update manager.

An integration or maintenance build is red. Should I take it ?

A red build doesn't mean that it is not usable. It just means that some tests failed. The impact of failing tests is often negligeable. E.g. if the releng tests are failing, it just means that there is a problem in the Javadoc. So you should always take the latest integration or maintenance build, unless someone posted on the platform-releng-dev mailing list that it is not usable.

Links