Skip to content

Commit

Permalink
Add 4.28 porting documentation stubs
Browse files Browse the repository at this point in the history
  • Loading branch information
akurtakov committed Mar 14, 2023
1 parent d3dbb24 commit 6856008
Show file tree
Hide file tree
Showing 5 changed files with 116 additions and 0 deletions.
22 changes: 22 additions & 0 deletions bundles/org.eclipse.platform.doc.isv/porting/4.28/faq.html
@@ -0,0 +1,22 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html lang="en">
<head>
<meta name="copyright" content="Copyright (c) 2022 IBM Corporation and others. 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" type="text/css">
<title>Eclipse 4.28 Plug-in Migration FAQ</title>
</head>
<body>
<h1>Eclipse 4.28 Plug-in Migration FAQ</h1>

<!--h2><a id="lucene">How did the Apache Lucene bundles change?</a></h2>
<p>As part of the Eclipse Platform's effort to support the latest version of Apatche Lucene, the third-party bundles changed in the following way:</p>
<ol>
<li>Bundle <code>org.apache.lucene.core</code> was bumped to version <code>9.4.2</code>. </li>
<li>Bundle <code>org.apache.lucene.analyzers-smartcn</code> was renamed to <code>org.apache.lucene.analysis-smartcn</code> and bumped to version <code>9.4.2</code>. </li>
<li>Bundle <code>org.apache.lucene.analyzers-common</code> was renamed to <code>org.apache.lucene.analysis-common</code> and bumped to version <code>9.4.2</code>. </li>
</ol-->

</body>
</html>
@@ -0,0 +1,14 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html lang="en">
<head>
<meta name="copyright" content="Copyright (c) 2022 IBM Corporation and others. 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=UTF-8">
<meta http-equiv="Content-Style-Type" content="text/css">
<link rel="STYLESHEET" href="../../book.css" type="text/css">
<title>Incompatibilities between Eclipse 4.27 and 4.28</title>
</head>
<body>
<h1>Incompatibilities between Eclipse 4.27 and 4.28</h1>

</body>
</html>
39 changes: 39 additions & 0 deletions bundles/org.eclipse.platform.doc.isv/porting/4.28/recommended.html
@@ -0,0 +1,39 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html lang="en">

<head>
<meta name="copyright"
content="Copyright (c) 2022 IBM Corporation and others. 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" type="text/css">
<title>Adopting 4.28 mechanisms and APIs</title>
</head>

<body>
<h1>Adopting 4.28 mechanisms and APIs</h1>

<p>This section describes changes that are required if you are
trying to change your 4.27 plug-in to adopt the 4.28 mechanisms and
APIs.</p>

<!-- ##############################################
<h2><a id="icu4j">Pre-built Lucene indexes should be updated</a></h2>
<p><strong>What is affected:</strong> Clients supplying pre-built Lucene help indexes.
</p>
<p><strong>Description:</strong>
We have updated the Apache Lucene search engine to Lucene 9.4.2. This means that the indexes
built with older versions will not be readable anymore. See <a
href="https://lucene.apache.org/core/9_4_2/changes/Changes.html">
Lucene Change Log</a> for details.
<p><strong>Action required:</strong>
Clients should:
</p>
<ul>
<li>Re-build their indexes with Lucene 9.4.2 and supply them as before></li>
</ul>
############################################## -->

</body>

</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) 2022 IBM Corporation and others. 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.28 Plug-in Migration Guide</title>
</head>

<body>

<h1>Eclipse 4.28 Plug-in Migration Guide</h1>
<p>This guide covers migrating Eclipse 4.27 plug-ins to Eclipse 4.28.</p>
<p>One of the goals of Eclipse 4.28 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.27 APIs should continue to work in 4.28 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.27 APIs remains valid for
4.28, 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.28 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.27 plug-ins to
4.28.</p>
<ul>
<li><a href="4.28/faq.html">Eclipse 4.28 Plug-in Migration FAQ</a></li>
<li><a href="4.28/incompatibilities.html">Incompatibilities between Eclipse 4.27 and 4.28</a></li>
<li><a href="4.28/recommended.html">Adopting 4.28 mechanisms and API</a></li>
</ul>

</body>
</html>
6 changes: 6 additions & 0 deletions bundles/org.eclipse.platform.doc.isv/topics_Porting.xml
Expand Up @@ -5,6 +5,12 @@
<!-- ============================================================================= -->
<toc label="Migration">
<topic label="Deprecated API removals" href="porting/removals.html"/>
<topic label="Migrating to Eclipse 4.28 from 4.27">
<topic label="Introduction" href="porting/eclipse_4_28_porting_guide.html"/>
<topic label="FAQ" href="porting/4.28/faq.html" />
<topic label="Incompatibilities" href="porting/4.28/incompatibilities.html" />
<topic label="Adopting 4.28 mechanisms and API" href="porting/4.28/recommended.html" />
</topic>
<topic label="Migrating to Eclipse 4.27 from 4.26">
<topic label="Introduction" href="porting/eclipse_4_27_porting_guide.html"/>
<topic label="FAQ" href="porting/4.27/faq.html" />
Expand Down

0 comments on commit 6856008

Please sign in to comment.