| Suggested text is here: http://wiki.eclipse.org/PTP/api_policy
Greg On May 21, 2010, at 4:54 PM, Chris Recoskie wrote: Typically you put a disclaimer in the javadoc comments saying it's an experimental work in progress that is subject to change. Mark the package as x-internal=true in the manifest.mf file. Then later when you feel the API is ready, you remove the flag and the comment.
I think we've been *fairly* good at marking RDT stuff as experimental in the comments but I'm not sure we've properly marked everything exhaustively. We definitely haven't marked the packages internal yet.
===========================
Chris Recoskie
Team Lead, IBM CDT and RDT
IBM Toronto
<graycol.gif>Beth Tibbitts ---05/21/2010 03:34:32 PM---How should we do that? I would like to do the same with much of the Feedback view, since it hasn't h
<ecblank.gif>
From: | <ecblank.gif>
Beth Tibbitts <tibbitts@xxxxxxxxxx> |
<ecblank.gif>
To: | <ecblank.gif>
Parallel Tools Platform general developers <ptp-dev@xxxxxxxxxxx> |
<ecblank.gif>
Date: | <ecblank.gif>
05/21/2010 03:34 PM |
<ecblank.gif>
Subject: | <ecblank.gif>
Re: [ptp-dev] API tooling |
<ecblank.gif>
Sent by: | <ecblank.gif>
ptp-dev-bounces@xxxxxxxxxxx |
How should we do that? I would like to do the same with much of the Feedback view, since it hasn't had much exercise yet, and I'd like to reserve the right to change it.
I have seen several ways to mark something as provisional (not API).
I prefer NOT to change the package name, because then i would have to change it late, and it would presumably break all the clients.
...Beth
Beth Tibbitts
Eclipse Parallel Tools Platform http://eclipse.org/ptp
IBM STG Communications Protocols and Tools
Mailing Address: IBM Corp., Coldstream Research Campus, 745 West New Circle Road, Lexington, KY 40511
<graycol.gif>Greg Watson ---05/21/2010 03:21:51 PM---Sure. You've marked interfaces as provisional, right? Greg
<ecblank.gif>
From: | <ecblank.gif>
Greg Watson <g.watson@xxxxxxxxxxxx> |
<ecblank.gif>
To: | <ecblank.gif>
Parallel Tools Platform general developers <ptp-dev@xxxxxxxxxxx> |
<ecblank.gif>
Date: | <ecblank.gif>
05/21/2010 03:21 PM |
<ecblank.gif>
Subject: | <ecblank.gif>
Re: [ptp-dev] API tooling |
<ecblank.gif>
Sent by: | <ecblank.gif>
ptp-dev-bounces@xxxxxxxxxxx |
Sure. You've marked interfaces as provisional, right?
Greg
On May 21, 2010, at 3:00 PM, Chris Recoskie <recoskie@xxxxxxxxxx> wrote:
I'm a bit concerned with declaring RDT to be API yet, as there is still work to be done to move the RSE specific implementation into its own plugin. I want to leave it provisional for now till we have a chance to fix that.
We can set all the RDT packages to be x-internal=true, and then the API tooling will ignore them.
===========================
Chris Recoskie
Team Lead, IBM CDT and RDT
IBM Toronto
<graycol.gif>Greg Watson ---05/20/2010 06:17:06 PM---Hi, You may have noticed that I've now enabled API tooling on all PTP plugins (except Photran, sorry
<ecblank.gif>
From: | <ecblank.gif>
Greg Watson <g.watson@xxxxxxxxxxxx> |
<ecblank.gif>
To: | <ecblank.gif>
Parallel Tools Platform general developers <ptp-dev@xxxxxxxxxxx> |
<ecblank.gif>
Date: | <ecblank.gif>
05/20/2010 06:17 PM |
<ecblank.gif>
Subject: | <ecblank.gif>
[ptp-dev] API tooling |
<ecblank.gif>
Sent by: | <ecblank.gif>
ptp-dev-bounces@xxxxxxxxxxx |
Hi,
You may have noticed that I've now enabled API tooling on all PTP plugins (except Photran, sorry Jeff). I've also (hopefully) fixed up all the API issues that were discovered doing this.
PTP developers should now configure their environments for API tooling, and ensure that API issues are addressed. We can no longer accept commits that break API rules. There is some good documentation on setting up and using API tooling here: http://wiki.eclipse.org/PDE/API_Tools/User_Guide
Also, I've updated the PTP developer guidelines with some additional information regarding error/warning settings for the Java compiler (http://wiki.eclipse.org/PTP/policy/developer_guidelines). I'd appreciate it if everyone would make sure their environments are configure appropriately.
Thanks,
Greg_______________________________________________
ptp-dev mailing list
ptp-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/ptp-dev
_______________________________________________
ptp-dev mailing list
ptp-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/ptp-dev_______________________________________________
ptp-dev mailing list
ptp-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/ptp-dev
_______________________________________________
ptp-dev mailing list
ptp-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/ptp-dev
ptp-dev mailing list
ptp-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/ptp-dev
|
