From 7c84361c94a046062735b96e0b7ff68f2c99f2cf Mon Sep 17 00:00:00 2001 From: Martin Oberhuber < martin.oberhuber@windriver.com> Date: Fri, 10 Nov 2006 22:04:05 +0000 Subject: [PATCH] Declare RSE API Provisional in ISV Docs --- .../build.properties | 3 +- .../provisional_api.html | 32 +++++++++ rse/doc/org.eclipse.dstore.doc.isv/toc.html | 55 ++++++++++----- rse/doc/org.eclipse.dstore.doc.isv/toc.xml | 60 ++++++++-------- .../org.eclipse.rse.doc.isv/build.properties | 6 +- .../guide/rse_int.html | 62 +++++++++++++---- .../guide/usingAPIs.html | 25 ++++++- .../provisional_api.html | 32 +++++++++ rse/doc/org.eclipse.rse.doc.isv/toc.xml | 40 +++++------ .../org.eclipse.rse.doc.isv/topics_Guide.xml | 69 ++++++++++--------- .../topics_Reference.xml | 36 +++++----- 11 files changed, 282 insertions(+), 138 deletions(-) create mode 100644 rse/doc/org.eclipse.dstore.doc.isv/provisional_api.html create mode 100644 rse/doc/org.eclipse.rse.doc.isv/provisional_api.html diff --git a/rse/doc/org.eclipse.dstore.doc.isv/build.properties b/rse/doc/org.eclipse.dstore.doc.isv/build.properties index 8788dc44d04..e69e2c016e3 100755 --- a/rse/doc/org.eclipse.dstore.doc.isv/build.properties +++ b/rse/doc/org.eclipse.dstore.doc.isv/build.properties @@ -18,5 +18,6 @@ bin.includes = META-INF/,\ toc.xml,\ guide/,\ index/,\ - reference/ + reference/,\ + provisional_api.html customBuildCallbacks = customBuildCallbacks.xml diff --git a/rse/doc/org.eclipse.dstore.doc.isv/provisional_api.html b/rse/doc/org.eclipse.dstore.doc.isv/provisional_api.html new file mode 100644 index 00000000000..ea205b0f3f0 --- /dev/null +++ b/rse/doc/org.eclipse.dstore.doc.isv/provisional_api.html @@ -0,0 +1,32 @@ + + + + + +Remote System Explorer API Status + + + + + +

Remote System Explorer API Status

+

Provisional API

+
+

Although RSE API has been reviewed and proven useful in earlier proprietary +versions, we want to give the Open Source Communitiy a chance to provide public +feedback and help further improving the APIs. Therefore,

+ +

As of RSE 1.0, all API is considered provisional.

+ +

This means, that we reserve the right to change any API after RSE 1.0 +in a not backward compatible way. All such API changes will be voted on +by committers on the +dsdp-tm-dev developer mailing list, and documented in a migration guide +for future releases. We expect that with Community Feedback, we'll reach a +stable, hardened API for RSE 2.0. Please give your feedback on +Eclipse Bugzilla +under category DSDP, Product Target Management.

+
+ + + \ No newline at end of file diff --git a/rse/doc/org.eclipse.dstore.doc.isv/toc.html b/rse/doc/org.eclipse.dstore.doc.isv/toc.html index a410f833cfc..19c48bc709d 100755 --- a/rse/doc/org.eclipse.dstore.doc.isv/toc.html +++ b/rse/doc/org.eclipse.dstore.doc.isv/toc.html @@ -1,18 +1,39 @@ - - - - - - - - RSE DataStore developer information - - - -

Using the RSE DataStore for Remote Communications

-This section provides information for tool developers who wish to -add server-side tooling capabilities. Using the RSE DataStore tooling -communication framework, server-side extensions can be written. The Remote System Explorer can be -extended to interface the new server-side extensions. - + + + + + + + + RSE DataStore developer information + + + +

Using the RSE DataStore for Remote Communications

+
+This section provides information for tool developers who wish to +add server-side tooling capabilities. Using the RSE DataStore tooling +communication framework, server-side extensions can be written. The Remote System Explorer can be +extended to interface the new server-side extensions. +
+ +

Provisional API

+
+

Although RSE API has been reviewed and proven useful in earlier proprietary +versions, we want to give the Open Source Communitiy a chance to provide public +feedback and help further improving the APIs. Therefore,

+ +

As of RSE 1.0, all API is considered provisional.

+ +

This means, that we reserve the right to change any API after RSE 1.0 +in a not backward compatible way. All such API changes will be voted on +by committers on the +dsdp-tm-dev developer mailing list, and documented in a migration guide +for future releases. We expect that with Community Feedback, we'll reach a +stable, hardened API for RSE 2.0. Please give your feedback on +Eclipse Bugzilla +under category DSDP, Product Target Management.

+
+ + \ No newline at end of file diff --git a/rse/doc/org.eclipse.dstore.doc.isv/toc.xml b/rse/doc/org.eclipse.dstore.doc.isv/toc.xml index 66c07c020fc..6ea4c48d12a 100755 --- a/rse/doc/org.eclipse.dstore.doc.isv/toc.xml +++ b/rse/doc/org.eclipse.dstore.doc.isv/toc.xml @@ -1,30 +1,30 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/rse/doc/org.eclipse.rse.doc.isv/build.properties b/rse/doc/org.eclipse.rse.doc.isv/build.properties index b34ce515a34..10fd0ba73cf 100755 --- a/rse/doc/org.eclipse.rse.doc.isv/build.properties +++ b/rse/doc/org.eclipse.rse.doc.isv/build.properties @@ -6,7 +6,8 @@ # http://www.eclipse.org/legal/epl-v10.html # # Contributors: -# IBM Corporation - initial API and implementation +# IBM Corporation - initial API and implementation +# Martin Oberhuber (Wind River) - Declare API provisional ############################################################################### bin.includes = META-INF/,\ about.html,\ @@ -25,5 +26,6 @@ bin.includes = META-INF/,\ index/,\ questions/,\ reference/,\ - samples/ + samples/,\ + provisional_api.html customBuildCallbacks = customBuildCallbacks.xml diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/rse_int.html b/rse/doc/org.eclipse.rse.doc.isv/guide/rse_int.html index e0fb49b684a..fcc4eaadc74 100755 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/rse_int.html +++ b/rse/doc/org.eclipse.rse.doc.isv/guide/rse_int.html @@ -1,16 +1,48 @@ - - - - - - - - -RSE Programmer's Guide - - - - -

RSE Programmer's Guide

- + + + + + + + + +RSE Programmer's Guide + + + + +

RSE Programmer's Guide

+
+This book explains how to use the Remote System Explorer APIs and Extension Points. +It provides an +
+ +

Provisional API

+ + +
+

Although RSE API has been reviewed and proven useful in earlier proprietary +versions, we want to give the Open Source Communitiy a chance to provide public +feedback and help further improving the APIs. Therefore,

+ +

As of RSE 1.0, all API is considered provisional.

+ +

This means, that we reserve the right to change any API after RSE 1.0 +in a not backward compatible way. All such API changes will be voted on +by committers on the +dsdp-tm-dev developer mailing list, and documented in a migration guide +for future releases. We expect that with Community Feedback, we'll reach a +stable, hardened API for RSE 2.0. Please give your feedback on +Eclipse Bugzillaunder +category DSDP, Product Target Management.

+
+ + \ No newline at end of file diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/usingAPIs.html b/rse/doc/org.eclipse.rse.doc.isv/guide/usingAPIs.html index 386ffeb36eb..8999da76ffa 100755 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/usingAPIs.html +++ b/rse/doc/org.eclipse.rse.doc.isv/guide/usingAPIs.html @@ -25,7 +25,30 @@ The API set supplied by the RSE can be roughly partitioned into three areas:

This guide will introduce the capabilities of the API, leaving the programming details to the -reference section. +reference section.

+ +

Provisional API

+ + +
+

Although RSE API has been reviewed and proven useful in earlier proprietary +versions, we want to give the Open Source Communitiy a chance to provide public +feedback and help further improving the APIs. Therefore,

+ +

As of RSE 1.0, all API is considered provisional.

+ +

This means, that we reserve the right to change any API after RSE 1.0 +in a not backward compatible way. All such API changes will be voted on +by committers on the +dsdp-tm-dev developer mailing list, and documented in a migration guide +for future releases. We expect that with Community Feedback, we'll reach a +stable, hardened API for RSE 2.0. Please give your feedback on +Eclipse Bugzilla +under category DSDP, Product Target Management.

+
\ No newline at end of file diff --git a/rse/doc/org.eclipse.rse.doc.isv/provisional_api.html b/rse/doc/org.eclipse.rse.doc.isv/provisional_api.html new file mode 100644 index 00000000000..ea205b0f3f0 --- /dev/null +++ b/rse/doc/org.eclipse.rse.doc.isv/provisional_api.html @@ -0,0 +1,32 @@ + + + + + +Remote System Explorer API Status + + + + + +

Remote System Explorer API Status

+

Provisional API

+
+

Although RSE API has been reviewed and proven useful in earlier proprietary +versions, we want to give the Open Source Communitiy a chance to provide public +feedback and help further improving the APIs. Therefore,

+ +

As of RSE 1.0, all API is considered provisional.

+ +

This means, that we reserve the right to change any API after RSE 1.0 +in a not backward compatible way. All such API changes will be voted on +by committers on the +dsdp-tm-dev developer mailing list, and documented in a migration guide +for future releases. We expect that with Community Feedback, we'll reach a +stable, hardened API for RSE 2.0. Please give your feedback on +Eclipse Bugzilla +under category DSDP, Product Target Management.

+
+ + + \ No newline at end of file diff --git a/rse/doc/org.eclipse.rse.doc.isv/toc.xml b/rse/doc/org.eclipse.rse.doc.isv/toc.xml index e48700d5c67..fc514b73ff9 100755 --- a/rse/doc/org.eclipse.rse.doc.isv/toc.xml +++ b/rse/doc/org.eclipse.rse.doc.isv/toc.xml @@ -1,21 +1,21 @@ - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/rse/doc/org.eclipse.rse.doc.isv/topics_Guide.xml b/rse/doc/org.eclipse.rse.doc.isv/topics_Guide.xml index c1356f3830d..43c1fd31473 100755 --- a/rse/doc/org.eclipse.rse.doc.isv/topics_Guide.xml +++ b/rse/doc/org.eclipse.rse.doc.isv/topics_Guide.xml @@ -1,35 +1,36 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/rse/doc/org.eclipse.rse.doc.isv/topics_Reference.xml b/rse/doc/org.eclipse.rse.doc.isv/topics_Reference.xml index fcb4e4dd39b..d4204c70a9f 100755 --- a/rse/doc/org.eclipse.rse.doc.isv/topics_Reference.xml +++ b/rse/doc/org.eclipse.rse.doc.isv/topics_Reference.xml @@ -5,7 +5,7 @@ - +