Bug 186134 - [api] Mark Terminal API as provisional
Summary: [api] Mark Terminal API as provisional
Status: RESOLVED FIXED
Alias: None
Product: Target Management
Classification: Tools
Component: Terminal (show other bugs)
Version: 2.0   Edit
Hardware: All All
: P3 enhancement (vote)
Target Milestone: 2.0   Edit
Assignee: Michael Scharf CLA
QA Contact: Martin Oberhuber CLA
URL:
Whiteboard:
Keywords: api
Depends on:
Blocks:
 
Reported: 2007-05-09 08:23 EDT by Martin Oberhuber CLA
Modified: 2008-08-13 13:18 EDT (History)
0 users

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Martin Oberhuber CLA 2007-05-09 08:23:12 EDT
As discussed in the Committer Meeting on
  http://wiki.eclipse.org/index.php/DSDP/TM/Committer_Phone_Meeting_8-May-2007
we do not consider the Terminal API finished for the TM 2.0 release.

We should therefore mark the Terminal API as provisional. According to 
  http://wiki.eclipse.org/index.php/Provisional_API_Guidelines
Eclipse provisional API guidelines say:
  * Provisional APIs that are not intended to become real API in time for the
    release should be in an internal package.
  * If provisional API is in an internal package, it should kept in a separate
    package from code that is never intended to become API. The
    "internal.provisional" naming convention can be used, but is not required
  * If the API is particularly volatile, experimental, or at risk of removal,
    a further comment in the javadoc can be used to clarify the state of the
    API: <strong>EXPERIMENTAL</strong>

Currently, there is only one API package in org.eclipse.tm.terminal. According
to the guidelines mentioned above, this package should be refactored to

org.eclipse.tm.internal.terminal.provisional        or
org.eclipse.tm.internal.terminal.api                or
org.eclipse.tm.internal.terminal.provisional.api    or

and the Javadoc of those interfaces and classes that we consider "more at risk than others" should get the <strong>EXPERIMENTAL</strong> tag as suggested by the Wiki page mentioned.
Comment 1 Michael Scharf CLA 2007-05-15 18:51:07 EDT
- renamed the org.eclipse.tm.terminal package to org.eclipse.tm.internal.terminal.provisional.api
- added the following comment to all classes/interfaces
   * <strong>EXPERIMENTAL</strong>. This class or interface has been added as
   * part of a work in progress. There is no guarantee that this API will
   * work or that it will remain the same. Please do not use this API without
   * consulting with the <a href="http://www.eclipse.org/dsdp/tm/">Target Management</a> team.
  
Comment 2 Martin Oberhuber CLA 2008-08-13 13:18:46 EDT
[target cleanup] 2.0 M7 was the original target milestone for this bug