Bug 259363 - [api][rseterminals] Move RSE-Terminals out of incubation
Summary: [api][rseterminals] Move RSE-Terminals out of incubation
Status: RESOLVED FIXED
Alias: None
Product: Target Management
Classification: Tools
Component: RSE (show other bugs)
Version: 3.0   Edit
Hardware: All All
: P3 enhancement (vote)
Target Milestone: 3.1 M5   Edit
Assignee: Anna Dushistova CLA
QA Contact: Martin Oberhuber CLA
URL:
Whiteboard:
Keywords: api
Depends on: 257694 263195 247700 258631
Blocks: 263189
  Show dependency tree
 
Reported: 2008-12-19 08:52 EST by Martin Oberhuber CLA
Modified: 2009-02-10 18:00 EST (History)
0 users

See Also:


Attachments
Patch reving rseterminal up to 1.0 (32.19 KB, patch)
2008-12-19 09:27 EST, Martin Oberhuber CLA
no flags Details | Diff
Additional patch for changing the Downloads page (3.04 KB, patch)
2008-12-19 11:03 EST, Martin Oberhuber CLA
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Martin Oberhuber CLA 2008-12-19 08:52:45 EST
The change in bug 258631 which made the ITerminalService public API had a big impact on the RSE Terminals integration, because its API in

   org.eclipse.rse.subsystems.terminals.core
   org.eclipse.rse.subsystems.terminals.ssh

uses parameters and return values from the org.eclipse.rse.services.terminals package which changed. As a result, the change from bug 258631 introduces a breaking change to the (currently incubating) RSE Terminals integration.

I'd like to take this opportunity to have the RSE Terminals integration graduate to version 1.0 in the TM 3.1 timeframe. The integration has been picked up by the Java EE Package already, and it was never a good idea to reference the "internal" ITerminalService stuff from the "public incubating" API in rse.subsystems.terminals.core.

Moving RSE-Terminals out of incubation means that we should carefully review the current APIs in org.eclipse.rse.subsystems.terminals.core -- maybe we want to take this opportunity to change something or move it out of public API before we cannot change it any more.
Comment 1 Martin Oberhuber CLA 2008-12-19 09:27:46 EST
Created attachment 120944 [details]
Patch reving rseterminal up to 1.0

Attached patch does the first important steps:

* Add the "API Analysis" nature to the 3 rseterminal plugins
* Add Class Javadocs everywhere (with an "EXPERIMENTAL" marker)
* Move version numbers up to 1.0 everywhere (required by API tooling)
* Remove "(Incubation)" from all plug-in and feature names
* Register the three new API packages in org.eclipse.rse.doc.isv
* Update the site.xml file to pick up the new feature version (1.0)

The RSE Tests feature was reved up to 3.1 along the way since it now contains tests for the new generic terminal shell, which is new in 3.1. The change is committed and released for RSE 3.1m4:
[259363][api][rseterminals] Move RSE-Terminals out of incubation

I'm leaving the bug open to perform the following additional tasks:
1.) Review the org.eclipse.rse.subsystems.terminals.core API classes
    - might want to get rid of some methods or classes, or change signature
2.) Review all Javadocs
3.) Get rid of the EXPERIMENTAL tag on all Javadocs.
Comment 2 Martin Oberhuber CLA 2008-12-19 09:28:22 EST
Should finish the API Review by M6.
Comment 3 Martin Oberhuber CLA 2008-12-19 11:03:08 EST
Created attachment 120958 [details]
Additional patch for changing the Downloads page
Comment 4 Martin Oberhuber CLA 2009-02-01 20:32:00 EST
The two attached patches have been committed. More work is scheduled via bug 263189, bug 263195, bug 247700 and bug 257694.
Comment 5 Martin Oberhuber CLA 2009-02-10 18:00:14 EST
I believe we can mark this bug fixed, since the "(Incubation)" is gone from all features and downloads, and the feature is part of the standard RSE runtime now. Remaining work will be tracked in the separate bugs mentioned.