Bug 574684 - Add help stubs for 4.21 Change-Id: Ibbad3b0d9f772ac301c8b839a75e0143fb7142ac Reviewed-on: https://git.eclipse.org/r/c/platform/eclipse.platform.common/+/182792 Tested-by: Alexander Kurtakov <akurtako@redhat.com> Reviewed-by: Alexander Kurtakov <akurtako@redhat.com>
diff --git a/bundles/org.eclipse.jdt.doc.isv/porting/4.21/faq.html b/bundles/org.eclipse.jdt.doc.isv/porting/4.21/faq.html new file mode 100644 index 0000000..bc052ed --- /dev/null +++ b/bundles/org.eclipse.jdt.doc.isv/porting/4.21/faq.html
@@ -0,0 +1,20 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html lang="en"> +<head> +<meta name="copyright" content="Copyright (c) 2020 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.21 Plug-in Migration FAQ</title> +</head> + +<body> + +<h1>Eclipse JDT 4.21 Plug-in Migration FAQ</h1> + +<ol> + <li>None</li> +</ol> + +</body> +</html>
diff --git a/bundles/org.eclipse.jdt.doc.isv/porting/4.21/incompatibilities.html b/bundles/org.eclipse.jdt.doc.isv/porting/4.21/incompatibilities.html new file mode 100644 index 0000000..8d3cc547 --- /dev/null +++ b/bundles/org.eclipse.jdt.doc.isv/porting/4.21/incompatibilities.html
@@ -0,0 +1,19 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html lang="en"> +<head> +<meta name="copyright" content="Copyright (c) 2020 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>Incompatibilities between Eclipse JDT 4.20 and 4.21</title> +</head> +<body> +<h1>Incompatibilities between Eclipse JDT 4.20 and 4.21</h1> + +<p> + So far Eclipse did not change incompatibly between 4.20 and 4.21 in ways that affect + plug-ins. Plug-ins that ran on 4.20 should run on 4.21 without any problems. +</p> + +</body> +</html>
diff --git a/bundles/org.eclipse.jdt.doc.isv/porting/4.21/recommended.html b/bundles/org.eclipse.jdt.doc.isv/porting/4.21/recommended.html new file mode 100644 index 0000000..f56c3ad --- /dev/null +++ b/bundles/org.eclipse.jdt.doc.isv/porting/4.21/recommended.html
@@ -0,0 +1,23 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html lang="en"> +<head> +<meta name="copyright" content="Copyright (c) 2020 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.21 mechanisms and APIs</title> +</head> + +<body> + +<h1>Adopting JDT 4.21 mechanisms and APIs</h1> +<p> + This section describes changes that are required if you are trying to change + your 4.20 plug-in to adopt the 4.21 mechanisms and APIs. +</p> + +<ol> + <li>None</li> +</ol> +</body> +</html>
diff --git a/bundles/org.eclipse.jdt.doc.isv/porting/eclipse_4_21_porting_guide.html b/bundles/org.eclipse.jdt.doc.isv/porting/eclipse_4_21_porting_guide.html new file mode 100644 index 0000000..72795eb --- /dev/null +++ b/bundles/org.eclipse.jdt.doc.isv/porting/eclipse_4_21_porting_guide.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) IBM 2020 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.21 Plug-in Migration Guide</title> +</head> + +<body> + +<h1>Eclipse JDT 4.21 Plug-in Migration Guide</h1> +<p>This guide covers migrating Eclipse JDT 4.20 plug-ins to Eclipse JDT 4.21.</p> +<p>One of the goals of Eclipse 4.21 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.20 APIs should continue to work in 4.21 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.20 APIs remains valid for + 4.21, 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 ("binary") code to no longer link and run with the + new 4.21 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.20 plug-ins to + 4.21.</p> +<ul> + <li><a href="4.21/faq.html">Eclipse JDT 4.21 Plug-in Migration FAQ</a></li> + <li><a href="4.21/incompatibilities.html">Incompatibilities between Eclipse JDT 4.20 and 4.21</a></li> + <li><a href="4.21/recommended.html">Adopting 4.21 mechanisms and API</a></li> +</ul> + +</body> +</html> \ No newline at end of file
diff --git a/bundles/org.eclipse.jdt.doc.isv/topics_Porting.xml b/bundles/org.eclipse.jdt.doc.isv/topics_Porting.xml index 4bda841..12a1798 100644 --- a/bundles/org.eclipse.jdt.doc.isv/topics_Porting.xml +++ b/bundles/org.eclipse.jdt.doc.isv/topics_Porting.xml
@@ -4,6 +4,12 @@ <!-- Define topics for the porting guide index --> <!-- ============================================================================= --> <toc label="Migration"> + <topic label="Migrating to Eclipse JDT 4.21 from 4.20"> + <topic label="Introduction" href="porting/eclipse_4_21_porting_guide.html"/> + <topic label="FAQ" href="porting/4.21/faq.html" /> + <topic label="Incompatibilities" href="porting/4.21/incompatibilities.html" /> + <topic label="Adopting 4.21 Mechanisms and API" href="porting/4.21/recommended.html" /> + </topic> <topic label="Migrating to Eclipse JDT 4.20 from 4.19"> <topic label="Introduction" href="porting/eclipse_4_20_porting_guide.html"/> <topic label="FAQ" href="porting/4.20/faq.html" />
diff --git a/bundles/org.eclipse.platform.doc.isv/porting/4.21/faq.html b/bundles/org.eclipse.platform.doc.isv/porting/4.21/faq.html new file mode 100644 index 0000000..daf4e7e --- /dev/null +++ b/bundles/org.eclipse.platform.doc.isv/porting/4.21/faq.html
@@ -0,0 +1,27 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html lang="en"> +<head> +<meta name="copyright" content="Copyright (c) 2020 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.21 Plug-in Migration FAQ</title> +</head> +<body> +<h1>Eclipse 4.21 Plug-in Migration FAQ</h1> + +<!--ol> + <li><a href="#project-layout">How can I force a Flat project layout in the <i>Project Explorer</i> view?</a></li> +</ol--> + +<hr> + +<!-- ############################################## --> +<!--h2><a name="project-layout">1. How can I force a Flat project layout in the <i>Project Explorer</i> view?</a></h2> +<p>As default Project Layout in Project Explorer has been switched to hierarchical, a new preference is available for RCP providers who want to force Flat layout by default instead. The preference is +<code>org.eclipse.ui.navigator.resources/defaultToFlatLayout</code> and can be set to <code>true</code> in <code>plugin_customization.ini</code> or programatically <i>before</i> Project Explorer opens +for the first time, in order to force a Flat project layout. Subsequent change to this preference after first initialization of Project Explorer will have no effect.</p--> +<!-- ############################################## --> + +</body> +</html>
diff --git a/bundles/org.eclipse.platform.doc.isv/porting/4.21/incompatibilities.html b/bundles/org.eclipse.platform.doc.isv/porting/4.21/incompatibilities.html new file mode 100644 index 0000000..3819312 --- /dev/null +++ b/bundles/org.eclipse.platform.doc.isv/porting/4.21/incompatibilities.html
@@ -0,0 +1,49 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html lang="en"> +<head> +<meta name="copyright" content="Copyright (c) 2020 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" charset="ISO-8859-1" type="text/css"> +<title>Incompatibilities between Eclipse 4.20 and 4.21</title> +</head> +<body> +<h1>Incompatibilities between Eclipse 4.20 and 4.21</h1> + +<p> + Eclipse changed in incompatible ways between 4.20 and 4.21 in ways that affect + plug-ins. The following entries describe the areas that changed and provide + instructions for migrating 4.20 plug-ins to 4.21. Note that you only need to look + here if you are experiencing problems running your 4.20 plug-in on 4.21. +</p> +<p> +See also the list of <a href="../removals.html">deprecated API removals</a> for this release. +</p> + + +<ol> +<!--li><a href="#servlet-4-update">Update to Servlet 4</a></li--> +</ol> + +<hr> + +<!-- ############################################## --> + + +<!--h2>1. <a name="jetty-10-update">Update to Servlet 4</a></h2> +<p><strong>What is affected:</strong> Clients that use <code>Servlet</code> APIs coming with Eclipse Platform. +</p> +<p><strong>Description:</strong></p> +Eclipse has updated to ship Servlet API to version 4 from previous version 3. +<p> +Bundle <code>javax.servlet</code> is renamed to <code>jakarta.servlet-api</code> to reflect the Servlet API being developed by JakartaEE project now. <br> +Version 4.0 still keeps the <code>javax.servlet</code> package names as change to <code>jakarta.servlet</code> package names is not yet adopted by Eclipse. +</p> +<p><strong>Action required:</strong></p> +<ol> + <li>Adjust build scripts, target platform and etc. to use the new bundle symbolic name. </li> + <li>Implement and adjust to new Servlet 4.0 APIs</li> +</ol--> + +</body> +</html>
diff --git a/bundles/org.eclipse.platform.doc.isv/porting/4.21/recommended.html b/bundles/org.eclipse.platform.doc.isv/porting/4.21/recommended.html new file mode 100644 index 0000000..6d5947e --- /dev/null +++ b/bundles/org.eclipse.platform.doc.isv/porting/4.21/recommended.html
@@ -0,0 +1,43 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html lang="en"> +<head> +<meta name="copyright" + content="Copyright (c) 2020 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 4.21 mechanisms and APIs</title> +</head> +<body> + <h1>Adopting 4.21 mechanisms and APIs</h1> + + <p>This section describes changes that are required if you are + trying to change your 4.20 plug-in to adopt the 4.21 mechanisms and + APIs.</p> + + <ol> + <!--li><a href="#pack200Removal">Pack200 artifacts will no longer be generated for Eclipse starting with 4.21 release</a></li--> + </ol> + + <hr> + + <!-- ############################################## --> + <!--h2> + 1. <a name="pack200Removal">Pack200 artifacts will no longer be generated starting with 4.21 release</a> + </h2> + <p> + <strong>What is affected:</strong> Clients relying on availability of pack200 artifacts (*.pack.gz) in Eclipse Platform p2 repository. + </p> + <p> + <strong>Description:</strong> Clients using pack200 (*.pack.gz) artifacts from Eclipse Platform p2 repository are advised to stop doing so and + rely on plain old *.jar files instead. + </p> + <p> + <strong>Action required:</strong> If your build system/scripts have strong requirement on existence of *.pack.gz artifacts for Eclipse Platform bits + do the needed modifications so it can work when these are not around prior to starting to build against 4.21 release. + + </p--> + +</body> +</html>
diff --git a/bundles/org.eclipse.platform.doc.isv/porting/eclipse_4_21_porting_guide.html b/bundles/org.eclipse.platform.doc.isv/porting/eclipse_4_21_porting_guide.html new file mode 100644 index 0000000..614ad49 --- /dev/null +++ b/bundles/org.eclipse.platform.doc.isv/porting/eclipse_4_21_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) 2020 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.21 Plug-in Migration Guide</title> +</head> + +<body> + +<h1>Eclipse 4.21 Plug-in Migration Guide</h1> +<p>This guide covers migrating Eclipse 4.20 plug-ins to Eclipse 4.21.</p> +<p>One of the goals of Eclipse 4.21 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.20 APIs should continue to work in 4.21 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.20 APIs remains valid for + 4.21, 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 ("binary") code to no longer link and run with the + new 4.21 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.20 plug-ins to + 4.21.</p> +<ul> + <li><a href="4.21/faq.html">Eclipse 4.21 Plug-in Migration FAQ</a></li> + <li><a href="4.21/incompatibilities.html">Incompatibilities between Eclipse 4.20 and 4.21</a></li> + <li><a href="4.21/recommended.html">Adopting 4.21 mechanisms and API</a></li> +</ul> + +</body> +</html>
diff --git a/bundles/org.eclipse.platform.doc.isv/topics_Porting.xml b/bundles/org.eclipse.platform.doc.isv/topics_Porting.xml index 8b0f0e8..a37ee0c 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.21 from 4.20"> + <topic label="Introduction" href="porting/eclipse_4_21_porting_guide.html"/> + <topic label="FAQ" href="porting/4.21/faq.html" /> + <topic label="Incompatibilities" href="porting/4.21/incompatibilities.html" /> + <topic label="Adopting 4.21 mechanisms and API" href="porting/4.21/recommended.html" /> + </topic> <topic label="Migrating to Eclipse 4.20 from 4.19"> <topic label="Introduction" href="porting/eclipse_4_20_porting_guide.html"/> <topic label="FAQ" href="porting/4.20/faq.html" />