Get your IP Log in Order

Having a up-to-date (and correct) IP Log is important for projects and we’re trying to provide as much help as we can to make sure that they’re in order.

I’ve been working with a couple of projects to help them get their IP Logs in order. In the process, I’ve managed to generalize a “review” script that run queries against the Eclipse Bugzilla instance to help identify bugs and attachments that should potentially be referenced as contributions in a project’s IP Log. I’ve already used this script to identify a couple of contributions that I neglected to record for the Examples and Eclipse IDE for Education (ide4edu) projects.

The script is currently pretty rough. I haven’t made any linkage to it from any other eclipse.org page, so you have to manually modify the URL to make it work for your project. It could probably also stand to have a little more prose added to better describe what it provides. You can see the results of running the script for Mylyn, and Examples. To try other projects, change the id parameter value to the id of the project (e.g. tools.mylyn, or technology.examples). FWIW, it doesn’t work on eclipse.platform as it requires too much server memory and it bails out. Close to a decade’s worth of bug reports will do that for you.

Using this script to poke around a bit, I’ve noticed a few projects that still don’t quite get the iplog+ thing. Clearly, I need to do a better job of working with projects to get this right.

The main benefit of using the Bugzilla iplog flag is that we can use this information to automatically generate an IP Log for the project. However, the generation process is only as good as the data it’s provided with. Here are a few pointers:

  • Only actual code contributions need to be included in the IP Log.
  • Only contributions from non-committers need to be included in the IP Log
  • Contributions that come from a developer before they become a committer do need to be included in the IP Log; the tools are smart enough to handle this time-sensitivity (so committer-provided contributions erroneously flagged as iplog+ are ignored).
  • Ideally, attachments should be flagged as iplog+ rather than bugs (if an attachment is flagged, the bug itself almost certainly should not be).
  • A bug might be flagged as iplog+ if the summary or one of the comments contains code that’s been rolled into the project’s source code repository.
  • Marking the bug iplog+ means that the summary and every comment are potential contributions that will need to be manually filtered when the IP Log is generated.

The page that results from the “review” script is read-only. You can’t actually change the iplog flag’s value from the page. But there are handy links that take you right to where you need to be if you decide that you do need to flag something. Hopefully this makes it easier.

As always, I invite your feedback. If this page turns out to be useful, I’ll sort out how to better incorporate it into eclipse.org.

This entry was posted in Community. Bookmark the permalink.

4 Responses to Get your IP Log in Order

  1. Ian Bull says:

    Here is a question that has confused me: What about contributions from those people who are not committers on the said project, but are Eclipse committers? Last year I was an Eclipse committer, but on a p2 committer. Would my code contributions to p2 require the iplog+ to be set?

  2. Wayne Beaton says:

    Good question Ian. If you are not a committer on the project you’re contributing to, your contributions need to be tracked. It doesn’t matter if you are a committer on another Eclipse project.

  3. Ian Bull says:

    Just to be even more picky, but when you say “Project”, what level do you mean? If you are a committer on a different component in the same project (p2 vs. Framework in Equinox), or different project in the same top level project (JDT vs. PDE in Eclipse), does this change things? I assume it’s at the Eclipse project (JDT, PDE, Equinox, EMF, etc..), but I thought I would check.

  4. Wayne Beaton says:

    The EDP makes no distinction between “component” and “project”. If you are a committer on one component of a project and make a contribution to another component in the same project, that contribution needs to be included in the IP Log. Further, that contribution is subject to the IP Policy (e.g if it is >250 LOC you need to create a CQ). HTH

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s