Community
Participate
Working Groups
This branding bundle for org.eclipse.sdk.examples has an empty plugin.xml. Not sure if there's some old, obscure technical reason for this, or if this is just so old and uncared for, no one's noticed. Its not been required since ?3.1?. Having a plugin.xml file there, that's not needed, isn't good and might "through off" some processing. (Though, can't find a reference for it for now, as to what harm that it causes, just statements that you shouldn't do it).
This bundle's manifest is also missing the Bundle-localization directive. It should be Bundle-Localization: plugin While removing the "plugin.xml" from the build.properties, I also see that eclipse32.gif was not exported (though eclipse.png was).
I've fixed in all branches. I think worth it, even in 3.8, since the lack of localization directive was causing some blank "name" fields, provider, etc., in the about box info. I incremented the version service field +1 to 101, since the localization change is valid service (and there have been other changes, such as pom file which will cause the qualifier to change. I made same substantive changes to R4_2_maintenance too, and incremented the service field to +100 to 200. The 4.x and 3.x bundles are identical, except for their icons ... but, they are different in their icons and should have always been versioned differently, IMHO. I made some changes to master, and have its service version as 200 also, as master and 4.2 are now identical. I cherry picked the final change (to version service field) so with any luck, they will have identical time-based qualifiers, as well.
I see now the "provider" was blank since not in the manifest, and the name was merely "Examples" instead of "Eclipse SDK Examples" because the manifest had Bundle-Name: Examples Hence, one more correction to make: Bundle-Name: %pluginName Bundle-Vendor: %providerName
Fix in for 12/11 8 AM build.
(In reply to comment #4) > Fix in for 12/11 8 AM build. It looks like they already ended up in I20121210-2000: http://git.eclipse.org/c/platform/eclipse.platform.releng.git/ With that build we lost all example doc and I'm almost 100% sure it is due to these changes which also went into 3.8.2 and 4.2.2. David, if you don't have time to investigate, then I suggest you revert all those changes in all branches and look into this at a later point.
(In reply to comment #5) > (In reply to comment #4) > > Fix in for 12/11 8 AM build. > > It looks like they already ended up in I20121210-2000: > http://git.eclipse.org/c/platform/eclipse.platform.releng.git/ > > With that build we lost all example doc and I'm almost 100% sure it is due > to these changes which also went into 3.8.2 and 4.2.2. > > David, if you don't have time to investigate, then I suggest you revert all > those changes in all branches and look into this at a later point. Thanks Dani, I'll be able to investigate ... can you be more specific what you are not seeing when you say example doc is missing? (I still see "Examples" in Help toc, so obviously don't know that you mean). And, do you mean when "plain SDK installed"? Or when Examples installed into SDK?
(In reply to comment #6) > (In reply to comment #5) > > (In reply to comment #4) > > > Fix in for 12/11 8 AM build. > > > > It looks like they already ended up in I20121210-2000: > > http://git.eclipse.org/c/platform/eclipse.platform.releng.git/ > > > > With that build we lost all example doc and I'm almost 100% sure it is due > > to these changes which also went into 3.8.2 and 4.2.2. > > > > David, if you don't have time to investigate, then I suggest you revert all > > those changes in all branches and look into this at a later point. > > Thanks Dani, I'll be able to investigate ... can you be more specific what > you are not seeing when you say example doc is missing? I found the bug when looking at the test results: the UA test which checks broken links started to fail. You can see the problem in the UI by opening the Help, then drill into Platform Plug-in Developer Guide > Examples Guide > Team (or any other component). From there, none of the sub-links work. So, you were pretty close ;-). > And, do you mean when "plain SDK installed"? Or when Examples installed into > SDK? No, the examples don't need to be installed to see the doc.
Created attachment 224566 [details] excerpt from build log showing the problem during buildDoc.xml The attached log shows the areas of interest, where the custom doc generation script can not find the "samples" it is looking for. After having tried to copy "examples docs" to "samples". Of the changes I made, I think only the empty plugin.xml file might effect that layout on disk, in the build's working area ... a hold over from how PDE "used to do things before OSGi manifests" ... is my guess. I couldn't find any evidence there the "plugin name" (and certainly not provider) would be part of the problem (though, "plugin name" was my first guess, since it was so plain, "Examples".) So, for tonight's I-build, will put back an empty plugin.xml file (and leave a comment in it, pointing back to this bug). If this "buildDocs" was going to be long lived task there might be better ways, but, my main concern was with the odd name and lack of "provider" in the about box ... looked unprofessional.
(In reply to comment #8) > Created attachment 224566 [details] > excerpt from build log showing the problem during buildDoc.xml > > The attached log shows the areas of interest, where the custom doc > generation script can not find the "samples" it is looking for. After having > tried to copy "examples docs" to "samples". > > Of the changes I made, I think only the empty plugin.xml file might effect > that layout on disk, in the build's working area ... a hold over from how > PDE "used to do things before OSGi manifests" ... is my guess. > > I couldn't find any evidence there the "plugin name" (and certainly not > provider) would be part of the problem (though, "plugin name" was my first > guess, since it was so plain, "Examples".) > > So, for tonight's I-build, will put back an empty plugin.xml file (and leave > a comment in it, pointing back to this bug). If this "buildDocs" was going > to be long lived task there might be better ways, but, my main concern was > with the odd name and lack of "provider" in the about box ... looked > unprofessional. Or, it's also caused by the same problem as bug 396272.
Hmmm, Yes, I see for bug 396272 Paul and Than just changed the "examplesDocCopy" task ... so think I'll hold off on reverting that empty plugin.xml and ask Paul to put in a verbose=true.
Pretty sure these changes have nothing to do with the current javadoc problems for samples, since it effects so many more plugins that is one. So, I've opened bug 396368 to code the samples docs.
Now when installed, the Examples shows up in about box under Eclipse SDK, instead of out on its own (think the grouping is determined by icon used and provider name).
