Skip to content

Commit

Permalink
Update Migration Guide for Platform and JDT for 4.28 Fixes (#150)
Browse files Browse the repository at this point in the history
  • Loading branch information
Shee43 committed Jun 2, 2023
1 parent 988e87e commit 3e853f7
Show file tree
Hide file tree
Showing 6 changed files with 125 additions and 23 deletions.
20 changes: 20 additions & 0 deletions bundles/org.eclipse.jdt.doc.isv/porting/4.28/faq.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html lang="en">
<head>
<meta name="copyright" content="Copyright (c) 2023 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 JDT 4.28 Plug-in Migration FAQ</title>
</head>

<body>

<h1>Eclipse JDT 4.28 Plug-in Migration FAQ</h1>

<ol>
<li>None</li>
</ol>

</body>
</html>
Original file line number Diff line number Diff line change
@@ -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>
23 changes: 23 additions & 0 deletions bundles/org.eclipse.jdt.doc.isv/porting/4.28/recommended.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html lang="en">
<head>
<meta name="copyright" content="Copyright (c) 2023 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>Adopting JDT 4.28 mechanisms and APIs</title>
</head>

<body>

<h1>Adopting JDT 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>

<ol>
<li>None</li>
</ol>
</body>
</html>
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html lang="en">

<head>

<meta name="copyright" content="Copyright (c) IBM 2023 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 JDT 4.28 Plug-in Migration Guide</title>
</head>

<body>

<h1>Eclipse JDT 4.28 Plug-in Migration Guide</h1>
<p>This guide covers migrating Eclipse JDT 4.27 plug-ins to Eclipse JDT 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 the
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 JDT 4.28 Plug-in Migration FAQ</a></li>
<li><a href="4.28/incompatibilities.html">Incompatibilities between Eclipse JDT 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>
30 changes: 18 additions & 12 deletions bundles/org.eclipse.jdt.doc.isv/topics_Porting.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@
<!-- Define topics for the porting guide index -->
<!-- ============================================================================= -->
<toc label="Migration">
<topic label="Migrating to Eclipse JDT 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 JDT 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 All @@ -22,19 +28,19 @@
<topic label="Incompatibilities" href="porting/4.25/incompatibilities.html" />
<topic label="Adopting 4.25 Mechanisms and API" href="porting/4.25/recommended.html" />
</topic>
<topic label="Migrating to Eclipse JDT 4.24 from 4.23">
<topic label="Introduction" href="porting/eclipse_4_24_porting_guide.html"/>
<topic label="FAQ" href="porting/4.24/faq.html" />
<topic label="Incompatibilities" href="porting/4.24/incompatibilities.html" />
<topic label="Adopting 4.24 Mechanisms and API" href="porting/4.24/recommended.html" />
</topic>
<topic label="Migrating to Eclipse JDT 4.23 from 4.22">
<topic label="Introduction" href="porting/eclipse_4_23_porting_guide.html"/>
<topic label="FAQ" href="porting/4.23/faq.html" />
<topic label="Incompatibilities" href="porting/4.23/incompatibilities.html" />
<topic label="Adopting 4.23 Mechanisms and API" href="porting/4.23/recommended.html" />
</topic>
<topic label="Older Migration Guides">
<topic label="Migrating to Eclipse JDT 4.24 from 4.23">
<topic label="Introduction" href="porting/eclipse_4_24_porting_guide.html"/>
<topic label="FAQ" href="porting/4.24/faq.html" />
<topic label="Incompatibilities" href="porting/4.24/incompatibilities.html" />
<topic label="Adopting 4.24 Mechanisms and API" href="porting/4.24/recommended.html" />
</topic>
<topic label="Migrating to Eclipse JDT 4.23 from 4.22">
<topic label="Introduction" href="porting/eclipse_4_23_porting_guide.html"/>
<topic label="FAQ" href="porting/4.23/faq.html" />
<topic label="Incompatibilities" href="porting/4.23/incompatibilities.html" />
<topic label="Adopting 4.23 Mechanisms and API" href="porting/4.23/recommended.html" />
</topic>
<topic label="Migrating to Eclipse JDT 4.22 from 4.21">
<topic label="Introduction" href="porting/eclipse_4_22_porting_guide.html"/>
<topic label="FAQ" href="porting/4.22/faq.html" />
Expand Down
22 changes: 11 additions & 11 deletions bundles/org.eclipse.platform.doc.isv/topics_Porting.xml
Original file line number Diff line number Diff line change
Expand Up @@ -29,19 +29,19 @@
<topic label="Incompatibilities" href="porting/4.25/incompatibilities.html" />
<topic label="Adopting 4.25 mechanisms and API" href="porting/4.25/recommended.html" />
</topic>
<topic label="Migrating to Eclipse 4.24 from 4.23">
<topic label="Introduction" href="porting/eclipse_4_24_porting_guide.html"/>
<topic label="FAQ" href="porting/4.24/faq.html" />
<topic label="Incompatibilities" href="porting/4.24/incompatibilities.html" />
<topic label="Adopting 4.24 mechanisms and API" href="porting/4.24/recommended.html" />
<topic label="Older Migration Guides">
<topic label="Migrating to Eclipse 4.24 from 4.23">
<topic label="Introduction" href="porting/eclipse_4_24_porting_guide.html"/>
<topic label="FAQ" href="porting/4.24/faq.html" />
<topic label="Incompatibilities" href="porting/4.24/incompatibilities.html" />
<topic label="Adopting 4.24 mechanisms and API" href="porting/4.24/recommended.html" />
</topic>
<topic label="Migrating to Eclipse 4.23 from 4.22">
<topic label="Introduction" href="porting/eclipse_4_23_porting_guide.html"/>
<topic label="FAQ" href="porting/4.23/faq.html" />
<topic label="Incompatibilities" href="porting/4.23/incompatibilities.html" />
<topic label="Adopting 4.23 mechanisms and API" href="porting/4.23/recommended.html" />
<topic label="Migrating to Eclipse 4.23 from 4.22">
<topic label="Introduction" href="porting/eclipse_4_23_porting_guide.html"/>
<topic label="FAQ" href="porting/4.23/faq.html" />
<topic label="Incompatibilities" href="porting/4.23/incompatibilities.html" />
<topic label="Adopting 4.23 mechanisms and API" href="porting/4.23/recommended.html" />
</topic>
<topic label="Older Migration Guides">
<topic label="Migrating to Eclipse 4.22 from 4.21">
<topic label="Introduction" href="porting/eclipse_4_22_porting_guide.html"/>
<topic label="FAQ" href="porting/4.22/faq.html" />
Expand Down

0 comments on commit 3e853f7

Please sign in to comment.