Attachment 238747 Details for Bug 311240 – Documentation update

[patch] Documentation update

patch311240_doc.txt (text/plain), 10.38 KB, created by Szymon Ptaszkiewicz

on 2014-01-07 11:58:22 EST

(hide)

Description:

Filename:

MIME Type:

Creator: Szymon Ptaszkiewicz

Created: 2014-01-07 11:58:22 EST

Size: 10.38 KB

patch

obsolete

>diff --git a/bundles/org.eclipse.platform.doc.isv/porting/4.4/faq.html b/bundles/org.eclipse.platform.doc.isv/porting/4.4/faq.html
>new file mode 100644
>index 0000000..7548c4b
>--- /dev/null
>+++ b/bundles/org.eclipse.platform.doc.isv/porting/4.4/faq.html
>@@ -0,0 +1,30 @@
>+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
>+<html lang="en">
>+<head>
>+<meta name="copyright" content="Copyright (c) IBM Corporation and others 2011. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
>+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
>+<meta http-equiv="Content-Style-Type" content="text/css">
>+<link rel="STYLESHEET" href="../../book.css" charset="ISO-8859-1" type="text/css">
>+<title>Eclipse 4.4 Plug-in Migration FAQ</title>
>+</head>
>+
>+<body>
>+
>+<h1>Eclipse 4.4 Plug-in Migration FAQ</h1>
>+
>+<ol>
>+	<li>No entries.</li>
>+</ol>
>+
>+<hr>
>+
>+
>+
>+
>+
>+
>+</body>
>+</html>
>diff --git a/bundles/org.eclipse.platform.doc.isv/porting/4.4/incompatibilities.html b/bundles/org.eclipse.platform.doc.isv/porting/4.4/incompatibilities.html
>new file mode 100644
>index 0000000..2d50760
>--- /dev/null
>+++ b/bundles/org.eclipse.platform.doc.isv/porting/4.4/incompatibilities.html
>@@ -0,0 +1,40 @@
>+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
>+<html lang="en">
>+<head>
>+<meta name="copyright" content="Copyright (c) IBM Corporation and others 2011, 2013. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
>+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
>+<meta http-equiv="Content-Style-Type" content="text/css">
>+<link rel="STYLESHEET" href="../../book.css" charset="ISO-8859-1" type="text/css">
>+<title>Incompatibilities between Eclipse 4.3 and 4.4</title>
>+</head>
>+
>+<body>
>+
>+<h1>Incompatibilities between Eclipse 4.3 and 4.4</h1>
>+
>+<p>
>+  Eclipse changed in incompatible ways between 4.3 and 4.4 in ways that affect 
>+  plug-ins. The following entries describe the areas that changed and provide 
>+  instructions for migrating 4.3 plug-ins to 4.4. Note that you only need to look 
>+  here if you are experiencing problems running your 4.3 plug-in on 4.4.
>+</p>
>+<p>
>+See also the list of <a href="../removals.html">deprecated API removals</a> for this release.
>+</p>
>+
>+<ol>
>+	<li>No entries.</li>
>+</ol>
>+
>+<hr>
>+
>+
>+
>+
>+
>+
>+</body>
>+</html>
>diff --git a/bundles/org.eclipse.platform.doc.isv/porting/4.4/recommended.html b/bundles/org.eclipse.platform.doc.isv/porting/4.4/recommended.html
>new file mode 100644
>index 0000000..a8fd5a6
>--- /dev/null
>+++ b/bundles/org.eclipse.platform.doc.isv/porting/4.4/recommended.html
>@@ -0,0 +1,35 @@
>+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
>+<html lang="en">
>+<head>
>+<meta name="copyright" content="Copyright (c) IBM Corporation and others 2011, 2013. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
>+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
>+<meta http-equiv="Content-Style-Type" content="text/css">
>+<link rel="STYLESHEET" href="../../book.css" charset="ISO-8859-1" type="text/css">
>+<title>Adopting 4.4 mechanisms and APIs</title>
>+</head>
>+
>+<body>
>+
>+<h1>Adopting 4.4 mechanisms and APIs</h1>
>+
>+<p>
>+  This section describes changes that are required if you are trying to change 
>+  your 4.3 plug-in to adopt the 4.4 mechanisms and APIs.
>+</p>
>+
>+<ol>
>+	<li>No entries.</li>
>+</ol>
>+
>+<hr>
>+
>+
>+
>+
>+
>+
>+</body>
>+</html>
>diff --git a/bundles/org.eclipse.platform.doc.isv/porting/eclipse_4_4_porting_guide.html b/bundles/org.eclipse.platform.doc.isv/porting/eclipse_4_4_porting_guide.html
>new file mode 100644
>index 0000000..34cd487
>--- /dev/null
>+++ b/bundles/org.eclipse.platform.doc.isv/porting/eclipse_4_4_porting_guide.html
>@@ -0,0 +1,35 @@
>+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
>+<html lang="en">
>+<head>
>+<meta name="copyright" content="Copyright (c) IBM Corporation and others 2011. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
>+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
>+<meta http-equiv="Content-Style-Type" content="text/css">
>+<link rel="STYLESHEET" href="../book.css" charset="ISO-8859-1" type="text/css">
>+<title>Eclipse 4.4 Plug-in Migration Guide</title>
>+</head>
>+
>+<body>
>+
>+<h1>Eclipse 4.4 Plug-in Migration Guide</h1>
>+<p>This guide covers migrating Eclipse 4.3 plug-ins to Eclipse 4.4.</p>
>+<p>One of the goals of Eclipse 4.4 was to move Eclipse forward while remaining compatible 
>+  with previous versions to the greatest extent possible. That is, plug-ins written 
>+  against the Eclipse 4.3 APIs should continue to work in 4.4 in spite of any API changes.</p>
>+<p>The key kinds of compatibility are API contract compatibility and binary compatibility. 
>+  API contract compatibility means that valid use of 4.3 APIs remains valid for 
>+  4.4, so there is no need to revisit working code. Binary compatibility means 
>+  that the API method signatures, etc. did not change in ways that would cause 
>+  existing compiled (&quot;binary&quot;) code to no longer link and run with the 
>+  new 4.4 libraries.</p>
>+<p>While every effort was made to avoid breakage, there are a few areas of incompatibility or new
>+  APIs that should be adopted by clients. 
>+  This document describes those areas and provides instructions for migrating 4.3 plug-ins to 
>+  4.4.</p>
>+<ul>
>+  <li><a href="4.4/faq.html">Eclipse 4.4 Plug-in Migration FAQ</a></li>
>+  <li><a href="4.4/incompatibilities.html">Incompatibilities between Eclipse 4.3 and 4.4</a></li>
>+  <li><a href="4.4/recommended.html">Adopting 4.4 mechanisms and API</a></li>
>+</ul>
>+
>+</body>
>+</html>
>diff --git a/bundles/org.eclipse.platform.doc.isv/porting/removals.html b/bundles/org.eclipse.platform.doc.isv/porting/removals.html
>index f29a96d..4a600f8 100644
>--- a/bundles/org.eclipse.platform.doc.isv/porting/removals.html
>+++ b/bundles/org.eclipse.platform.doc.isv/porting/removals.html
>@@ -24,17 +24,16 @@
> </p>
> 
> <p>
>-API removals in the Kepler (4.3) release:
>+API removals in the Luna (4.4) release:
> </p>
> <ol>
>- <li><a href="#luceneSearchParticipants">luceneSearchParticipants</a></li>
>+ <li><a href="#workspaceLock">WorkspaceLock</a></li>
> </ol>
> 
> <p>
> API removals after June 2013:
> </p>
> <ol>
>- <li><a href="#workspaceLock">WorkspaceLock</a></li>
>  <li><a href="#incrementalProjectBuilder_getRule">IncrementalProjectBuilder#getRule()</a></li>
> </ol>
> <p>
>@@ -54,33 +53,6 @@
> 
> <h2>API removals in this release</h2>
> 
>-<h3>1. <a name="luceneSearchParticipants">luceneSearchParticipants</a></h3>
>-<p>
>-The extension point <code>org.eclipse.help.base.luceneSearchParticipants</code> 
>-used API classes which exposed classes from Apache Lucene in their method parameters. 
>-This means that clients would be impacted with at least binary incompatibility if the Eclipse 
>-Help system switched from Lucene 1.x to 2.x or 3.x and has caused the help system 
>-to stay on an old version of Lucene. In the 3.6 release this extension point and the classes 
>-it requires were deprecated. The replacement extension point 
>-<code>org.eclipse.help.base.searchParticipant</code> should be used instead. 
>-The specific API being removed includes:
>-</p>
>-<ul>
>-
>-<li>The extension point org.eclipse.help.base.luceneSearchParticipants</li>
>-<li>The class org.eclipse.help.search.LuceneSearchParticipant</li>
>-<li>The class org.eclipse.help.search.ISearchIndex</li>
>-<li>The class org.eclipse.help.search.XMLSearchParticipant</li>
>-
>-</ul>
>-<p>
>-For further details or to provide feedback on this change, see <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=311931">bug 311931</a>.
>-</p>
>-
>-
>-
>-<h2>API removals after June 2013</h2>
>-
> <h3>1. <a name="workspaceLock">WorkspaceLock</a></h3>
> <p>
> The <code>WorkspaceLock</code> API allowed a special client (usually platform UI) to
>@@ -89,7 +61,7 @@
> and was never intended to be used by other clients. In the 3.0 release this API
> was deprecated in favor of a more general API provided by the <code>org.eclipse.core.jobs</code>
> bundle. Invoking this API has had no effect since the 3.0 release. The specific API
>-to be removed includes:
>+being removed includes:
> </p>
> <ul>
> <li>The <code>org.eclipse.core.resources.WorkspaceLock</code> class.</li>
>@@ -101,7 +73,9 @@
> 
> 
> 
>-<h3>2. <a name="incrementalProjectBuilder_getRule">IncrementalProjectBuilder#getRule()</a></h3>
>+<h2>API removals after June 2013</h2>
>+
>+<h3>1. <a name="incrementalProjectBuilder_getRule">IncrementalProjectBuilder#getRule()</a></h3>
> <p>
> The <code>IncrementalProjectBuilder#getRule()</code> method returned a scheduling rule 
> that was required for building the project by the builder. This method was intended to be used by the builder framework only.
>diff --git a/bundles/org.eclipse.platform.doc.isv/topics_Porting.xml b/bundles/org.eclipse.platform.doc.isv/topics_Porting.xml
>index e38fb32..3009f6a 100644
>--- a/bundles/org.eclipse.platform.doc.isv/topics_Porting.xml
>+++ b/bundles/org.eclipse.platform.doc.isv/topics_Porting.xml
>@@ -5,6 +5,12 @@
> 
> <toc label="Migration">
> 	<topic label="Deprecated API removals" href="porting/removals.html"/>
>+	<topic label="Migrating to Eclipse 4.4 from 4.3">
>+		<topic label="Introduction" href="porting/eclipse_4_4_porting_guide.html"/>
>+		<topic label="FAQ" href="porting/4.4/faq.html" />
>+		<topic label="Incompatibilities" href="porting/4.4/incompatibilities.html" />
>+		<topic label="Adopting 4.4 mechanisms and API" href="porting/4.4/recommended.html" />
>+	</topic>
> 	<topic label="Migrating to Eclipse 4.3 from 4.2">
> 		<topic label="Introduction" href="porting/eclipse_4_3_porting_guide.html"/>
> 		<topic label="FAQ" href="porting/4.3/faq.html" />

Actions: View | Diff

Attachments on bug 311240: 238450 | 238747