Bug 407766 - Update platform readme for Kepler
Summary: Update platform readme for Kepler
Status: VERIFIED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: Doc (show other bugs)
Version: 4.3   Edit
Hardware: PC Windows 7
: P3 normal (vote)
Target Milestone: 4.3 RC4   Edit
Assignee: John Arthorne CLA
QA Contact:
URL:
Whiteboard:
Keywords: Documentation
: 407824 (view as bug list)
Depends on: 397226 409271
Blocks:
  Show dependency tree
 
Reported: 2013-05-10 13:26 EDT by John Arthorne CLA
Modified: 2013-06-06 03:28 EDT (History)
5 users (show)

See Also:
john.arthorne: documentation+


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description John Arthorne CLA 2013-05-10 13:26:12 EDT
We need to update the main platform readme for any changes in Kepler.
Comment 1 John Arthorne CLA 2013-05-17 10:52:07 EDT
I have done my major update. Leaving open for documenting specific problems.

http://git.eclipse.org/c/platform/eclipse.platform.releng.git/commit/?id=be5702edea46e690195ff844d1994e9fac0f2123
Comment 2 David Williams CLA 2013-05-23 00:00:08 EDT
*** Bug 407824 has been marked as a duplicate of this bug. ***
Comment 3 Grant Gayed CLA 2013-05-23 15:13:05 EDT
The last two items in the 3.2.6 - SWT section should be removed.  They are:
- Toolbar controls on GTK are not properly sized
- Navigation using tab and arrow keys
Comment 4 Markus Keller CLA 2013-05-24 09:32:30 EDT
SWT:
- BIDI Segments in text controls only work on Windows and GTK.
=> "Text" must be capitalized, since this is about the Text widget's addSegmentListener(..) API and doesn't apply to StyledText.

JDT:
- Some refactoring script operations fail with Sun 6.0 JREs
=> Remove the whole item. This works fine in current Oracle JREs.
Comment 5 David Williams CLA 2013-05-26 23:39:01 EDT
Are "migration" issues listed here? If so, might want to document removal of org.junit4 stub bundle (bug 383240) and that typically consumes simply have to change their manifest to use "org.junit" instead of "org.junit4"?
Comment 6 John Arthorne CLA 2013-05-26 23:42:51 EDT
(In reply to comment #5)
> Are "migration" issues listed here? If so, might want to document removal of
> org.junit4 stub bundle (bug 383240) and that typically consumes simply have
> to change their manifest to use "org.junit" instead of "org.junit4"?

That should really go in the porting guide. There is a very general section on migration in the readme but it is for the kind of information that doesn't change from year to year.
Comment 7 David Williams CLA 2013-05-26 23:50:32 EDT
Ok, how about "known issues"? If so ... I'm not sure how to word it ... but we might want to mention that "inner jars" are not signed (bug 401098), and this can cause problems running unit tests that depend on using their own classloader (bug 408901). [There may be work arounds relaxing the JRE's security settings if simply running tests, but there might be other "running code" that would be effected where that would not be desirable. For an example, see bug 401098 comment 1 -- I'm assuming Tom's workaround would translate into using 
-Dosgi.support.class.certificate=false ... but, not positive].
Comment 8 David Williams CLA 2013-05-27 02:02:04 EDT
(In reply to comment #7)
> Ok, how about "known issues"? If so ... I'm not sure how to word it ... but
> we might want to mention that "inner jars" are not signed (bug 401098), and
> this can cause problems running unit tests that depend on using their own
> classloader (bug 408901). [There may be work arounds relaxing the JRE's
> security settings if simply running tests, but there might be other "running
> code" that would be effected where that would not be desirable. For an
> example, see bug 401098 comment 1 -- I'm assuming Tom's workaround would
> translate into using 
> -Dosgi.support.class.certificate=false ... but, not positive].

No, I tried with users test case and didn't help ... must be specific to Tom's tests.
Comment 9 Markus Keller CLA 2013-05-27 09:20:59 EDT
Re org.junit bundles: I've already added this to
org.eclipse.jdt.doc.isv/porting/3.9/incompatibilities.html, see bug 400441.

But the readme_eclipse.html only contains links to a (not yet existing) eclipse_4_3_porting_guide.html, which I assume will be the one from org.eclipse.platform.doc.isv/porting/.

The readme_eclipse.html should either also refer to the JDT porting guide at /org.eclipse.jdt.doc.isv/porting/eclipse_3_9_porting_guide.html, or we retire the JDT porting guide and put stuff from there into the platform porting guide as well.
Comment 10 John Arthorne CLA 2013-05-27 10:24:17 EDT
(In reply to comment #9)
> The readme_eclipse.html should either also refer to the JDT porting guide at
> /org.eclipse.jdt.doc.isv/porting/eclipse_3_9_porting_guide.html, or we
> retire the JDT porting guide and put stuff from there into the platform
> porting guide as well.

I just started doing that last year because in the past I just linked into ViewCVS. I must have forgotten about the JDT porting guide. I made a note to include the JDT porting guide on the web site as well (the link you see in the readme and plan documents).
Comment 11 Dani Megert CLA 2013-05-28 07:38:30 EDT
(In reply to comment #1)
> I have done my major update. Leaving open for documenting specific problems.
> 
> http://git.eclipse.org/c/platform/eclipse.platform.releng.git/commit/
> ?id=be5702edea46e690195ff844d1994e9fac0f2123

We (or at least I) usually used
http://git.eclipse.org/c/platform/eclipse.platform.releng.git/tree/features/org.eclipse.platform-feature/rootfiles/readme?id=be5702edea46e690195ff844d1994e9fac0f2123
as master. Did you take all changes from there into the RCP version?
Comment 12 John Arthorne CLA 2013-05-28 15:57:29 EDT
(In reply to comment #11)
> We (or at least I) usually used
> http://git.eclipse.org/c/platform/eclipse.platform.releng.git/tree/features/
> org.eclipse.platform-feature/rootfiles/
> readme?id=be5702edea46e690195ff844d1994e9fac0f2123
> as master. Did you take all changes from there into the RCP version?

I don't see any changes from the platform-feature readme in the past 7 months so I think we are fine. I also can't see any evidence that copy of the readme is used anywhere. I have not updated it for Kepler, yet the Eclipse SDK and Eclipse Platform downloads do contain the most up to date readme with all my recent changes.  I will continue updating just the RCP one for now, since that is the one that is appearing in our builds. I will update the platform-feature copy at the very end just in case it appears somewhere. After Kepler we should try removing the platform-feature copy and see if that has any effect.
Comment 13 John Arthorne CLA 2013-05-28 17:13:09 EDT
(In reply to comment #3)
> The last two items in the 3.2.6 - SWT section should be removed.  They are:
> - Toolbar controls on GTK are not properly sized
> - Navigation using tab and arrow keys

Done.

(In reply to comment #4)
> SWT:
> - BIDI Segments in text controls only work on Windows and GTK.
> => "Text" must be capitalized, since this is about the Text widget's
> addSegmentListener(..) API and doesn't apply to StyledText.
> 
> JDT:
> - Some refactoring script operations fail with Sun 6.0 JREs
> => Remove the whole item. This works fine in current Oracle JREs.

Fixed.
Comment 14 Markus Keller CLA 2013-05-29 05:56:49 EDT
(In reply to bug 397226 comment #23)
> 1) You need to add this after the setenv: "Then restart your Mac."
-> This is still missing.

- The title should be:
<h4>Problems with non-ASCII file names on Mac OS X</h4>
or:
<h4>Cannot access files/folders with non-ASCII names on Mac OS X</h4>

- There's still a reference to "MacOS X" (should be "Mac OS X").
Comment 15 Dani Megert CLA 2013-05-29 06:59:36 EDT
(In reply to comment #14)
> (In reply to bug 397226 comment #23)
> > 1) You need to add this after the setenv: "Then restart your Mac."
> -> This is still missing.
> 
> - The title should be:
> <h4>Problems with non-ASCII file names on Mac OS X</h4>
> or:
> <h4>Cannot access files/folders with non-ASCII names on Mac OS X</h4>
> 
> - There's still a reference to "MacOS X" (should be "Mac OS X").

Fixed in master.
Comment 16 Dani Megert CLA 2013-05-29 06:59:57 EDT
(In reply to comment #12)
> I will continue updating just the RCP
> one for now, since that is the one that is appearing in our builds.

Indeed!


> I will
> update the platform-feature copy at the very end just in case it appears
> somewhere. After Kepler we should try removing the platform-feature copy and
> see if that has any effect.

+1. Filed bug 409375 for that.
Comment 17 Paul Webster CLA 2013-06-05 14:08:52 EDT
Released update to Platform UI known issues.

http://git.eclipse.org/c/platform/eclipse.platform.releng.git/commit/?id=28aff176d9423c92418bbb3b2af41548638d5bb1

PW
Comment 18 Dani Megert CLA 2013-06-06 03:28:01 EDT
Verified in I20130605-2000, that the readme is in our build.

The "last revised" date is wrong as it was not updated along with the last change. I fixed this with:
http://git.eclipse.org/c/platform/eclipse.platform.releng.git/commit/?id=27de2207dfc41f5beb7d5a87b466971d20e44455
so that it will be picked up, in case there will be another build for Kepler, and to ensure that the readme on the download page is correct. Not worth to request a rebuild for this though.

I've also updated the copy in the platform-feature with:
http://git.eclipse.org/c/platform/eclipse.platform.releng.git/commit/?id=d9c4aaae3e48dfe76cc1ba81c7607a4c475673dd

and added the current version to our Web site:
http://www.eclipse.org/eclipse/development/readme_eclipse_4.3.php