Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 379847 - Remove source plugin that does not exist
Summary: Remove source plugin that does not exist
Status: RESOLVED FIXED
Alias: None
Product: Equinox
Classification: Eclipse Project
Component: Framework (show other bugs)
Version: unspecified   Edit
Hardware: PC Linux
: P3 normal (vote)
Target Milestone: Juno SR2   Edit
Assignee: Thomas Watson CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks: 379748
  Show dependency tree
 
Reported: 2012-05-17 16:09 EDT by Thanh Ha CLA
Modified: 2012-09-19 15:06 EDT (History)
7 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Thanh Ha CLA 2012-05-17 16:09:56 EDT
We need to remove a source bundle from features that don't generate bundles
with any source.  This is for CBI platform build preparation.


rt.equinox.framework/org.eclipse.equinox.core.sdk/feature.xml:
<!--
<plugin
          id="org.eclipse.equinox.console.jaas.fragment.source"
          download-size="0"
          install-size="0"
          version="0.0.0"
          unpack="false"/>
-->
Comment 1 Thomas Watson CLA 2012-05-18 10:52:42 EDT
(In reply to comment #0)
> We need to remove a source bundle from features that don't generate bundles
> with any source.  This is for CBI platform build preparation.
> 
> 
> rt.equinox.framework/org.eclipse.equinox.core.sdk/feature.xml:
> <!--
> <plugin
>           id="org.eclipse.equinox.console.jaas.fragment.source"
>           download-size="0"
>           install-size="0"
>           version="0.0.0"
>           unpack="false"/>
> -->

This source bundle exists in the equinox SDK so I am not sure what you mean by removing it from features that don't generate bundles with source.  the org.eclipse.equinox.core.sdk feature has lots of other references to source bundles.  It is only this one that is causing you issues.

I will say that this fragment has no java source.  It only contains a OSGi bundle manifest (in order to add a dynamic import to a host bundle).  I also noticed that the build.properties file at:

http://git.eclipse.org/c/equinox/rt.equinox.bundles.git/tree/bundles/org.eclipse.equinox.console.jaas.fragment/build.properties

Does not indicate that the about.html should be included in the source bundle, but I think it should.  Perhaps this is causing CBI issues because we now have a truly empty source bundle?  I am pretty sure we have other examples of empty source bundles that include at least an about.html.
Comment 2 Thomas Watson CLA 2012-05-18 10:54:13 EDT
Marking for RC3.  We should at least make sure the source bundle includes the about.html.
Comment 3 Thomas Watson CLA 2012-05-18 10:58:21 EDT
I mean RC2.
Comment 4 John Arthorne CLA 2012-05-18 11:05:32 EDT
Thanh, do you know why this particular bundle is causing problems in CBI? We have several other source bundles with no Java code (see bug 379967). We should ideally clean these up after Juno, but removing bundles is not without risk because there may be features that reference them.
Comment 5 Thanh Ha CLA 2012-05-18 11:21:27 EDT
(In reply to comment #4)
> Thanh, do you know why this particular bundle is causing problems in CBI? We
> have several other source bundles with no Java code (see bug 379967). We should
> ideally clean these up after Juno, but removing bundles is not without risk
> because there may be features that reference them.

Back in March when I was rebasing M4 -> M5 for CBI I had issues with the build regarding this bundle. Tycho was not able to find org.eclipse.equinox.console.jaas.fragment.source and thus could not build.

At the time I asked on CBI Dev for help and Igor suggested the following

"org.eclipse.equinox.console.jaas.fragment.source does not have any
sources afaict, at least it did not in M4. Tycho does not generate
source bunldes for bundles without sources. You need to remove it from
org.eclipse.equinox.core.sdk feature.xml."

archive: http://dev.eclipse.org/mhonarc/lists/cbi-dev/msg00168.html


I've added Igor to this bug.
Comment 6 Thomas Watson CLA 2012-05-21 10:04:34 EDT
I added the about.html files to the source bundles of org.eclipse.equinox.console.jaas.fragment org.eclipse.equinox.console.ssh in commit:

http://git.eclipse.org/c/equinox/rt.equinox.bundles.git/commit/?id=1ec5d598faf02450e0c127e1890e94700a0c2821

I'm not sure if helps with this bug or not, but it needed to be done regardless.
Comment 7 Thanh Ha CLA 2012-05-21 21:39:47 EDT
(In reply to comment #6)
> I added the about.html files to the source bundles of
> org.eclipse.equinox.console.jaas.fragment org.eclipse.equinox.console.ssh in
> commit:
> 
> http://git.eclipse.org/c/equinox/rt.equinox.bundles.git/commit/?id=1ec5d598faf02450e0c127e1890e94700a0c2821
> 
> I'm not sure if helps with this bug or not, but it needed to be done
> regardless.

I just gave this patch a try with the CBI build and it seems we still need to comment out the .source bundle in order to successfully build.
Comment 8 Thomas Watson CLA 2012-05-22 08:13:16 EDT
(In reply to comment #7)
> (In reply to comment #6)
> > I added the about.html files to the source bundles of
> > org.eclipse.equinox.console.jaas.fragment org.eclipse.equinox.console.ssh in
> > commit:
> > 
> > http://git.eclipse.org/c/equinox/rt.equinox.bundles.git/commit/?id=1ec5d598faf02450e0c127e1890e94700a0c2821
> > 
> > I'm not sure if helps with this bug or not, but it needed to be done
> > regardless.
> 
> I just gave this patch a try with the CBI build and it seems we still need to
> comment out the .source bundle in order to successfully build.

Can you explain why this one fails but others do not in bug 379967
Comment 9 Thanh Ha CLA 2012-05-22 11:43:51 EDT
(In reply to comment #8)
> (In reply to comment #7)
> > (In reply to comment #6)
> > > I added the about.html files to the source bundles of
> > > org.eclipse.equinox.console.jaas.fragment org.eclipse.equinox.console.ssh in
> > > commit:
> > > 
> > > http://git.eclipse.org/c/equinox/rt.equinox.bundles.git/commit/?id=1ec5d598faf02450e0c127e1890e94700a0c2821
> > > 
> > > I'm not sure if helps with this bug or not, but it needed to be done
> > > regardless.
> > 
> > I just gave this patch a try with the CBI build and it seems we still need to
> > comment out the .source bundle in order to successfully build.
> 
> Can you explain why this one fails but others do not in bug 379967


I decided to have a closer look and discovered that if I add an additional line to the console.jaas.fragment's build.properties:

source.. = src/

The build succeeds. I'm not entirely sure why this is but I discovered this by comparing the build.properties from other source bundles and noticed some differences.
Comment 10 Thomas Watson CLA 2012-05-22 12:10:59 EDT
(In reply to comment #9)
> (In reply to comment #8)
> > (In reply to comment #7)
> > > (In reply to comment #6)
> > > > I added the about.html files to the source bundles of
> > > > org.eclipse.equinox.console.jaas.fragment org.eclipse.equinox.console.ssh in
> > > > commit:
> > > > 
> > > > http://git.eclipse.org/c/equinox/rt.equinox.bundles.git/commit/?id=1ec5d598faf02450e0c127e1890e94700a0c2821
> > > > 
> > > > I'm not sure if helps with this bug or not, but it needed to be done
> > > > regardless.
> > > 
> > > I just gave this patch a try with the CBI build and it seems we still need to
> > > comment out the .source bundle in order to successfully build.
> > 
> > Can you explain why this one fails but others do not in bug 379967
> 
> 
> I decided to have a closer look and discovered that if I add an additional line
> to the console.jaas.fragment's build.properties:
> 
> source.. = src/
> 
> The build succeeds. I'm not entirely sure why this is but I discovered this by
> comparing the build.properties from other source bundles and noticed some
> differences.

But that contradicts other cases where we have empty source bundles:

http://git.eclipse.org/c/platform/eclipse.platform.releng.git/tree/bundles/org.eclipse.rcp/build.properties

Are you able to build the org.eclipse.rcp source bundle?
Comment 11 Thanh Ha CLA 2012-05-22 12:18:51 EDT
(In reply to comment #10)
> But that contradicts other cases where we have empty source bundles:
> 
> http://git.eclipse.org/c/platform/eclipse.platform.releng.git/tree/bundles/org.eclipse.rcp/build.properties
> 
> Are you able to build the org.eclipse.rcp source bundle?

Yes, but in the case of org.eclipse.rcp there also exists a features/org.eclipse.rcp

I think in this case the org.eclipse.rcp.source is coming from the feature via the "tycho-source-feature-plugin" in the pom.
Comment 12 Thomas Watson CLA 2012-05-22 14:07:40 EDT
Unfortunately adding source.. = src/ is a no go as a workaround.  It causes the bundle to fail to export from the workspace if you enable source code bundle generation.  I suspect it would also cause a failure during our automated build.
Comment 13 Thanh Ha CLA 2012-05-22 14:44:10 EDT
(In reply to comment #12)
> Unfortunately adding source.. = src/ is a no go as a workaround.  It causes the
> bundle to fail to export from the workspace if you enable source code bundle
> generation.  I suspect it would also cause a failure during our automated
> build.

Igor, do you know another way we can ignore this source bundle? Perhaps via the pom?
Comment 14 John Arthorne CLA 2012-05-23 09:27:21 EDT
I think the right fix here is for us to stop producing this source bundle (using generateSourceBundle=false in build.properties). Removing a bundle (even a useless one) is risky at this point so I suggest we push it out to 4.2.1/4.3.
Comment 15 Thomas Watson CLA 2012-05-23 09:39:39 EDT
(In reply to comment #14)
> I think the right fix here is for us to stop producing this source bundle
> (using generateSourceBundle=false in build.properties). Removing a bundle (even
> a useless one) is risky at this point so I suggest we push it out to 4.2.1/4.3.

I agree, pushing out to SR1.
Comment 16 Thomas Watson CLA 2012-08-01 11:06:12 EDT
(In reply to comment #14)
> I think the right fix here is for us to stop producing this source bundle
> (using generateSourceBundle=false in build.properties). Removing a bundle
> (even a useless one) is risky at this point so I suggest we push it out to
> 4.2.1/4.3.

John, do you know all the changes that are needed to do this.  Is it simply adding generateSourceBundle=false in the build.properites or do we also need to update some of our features.
Comment 17 John Arthorne CLA 2012-08-01 12:04:10 EDT
I think it is just the build.properties change, but CCing David to correct me if wrong.
Comment 18 David Williams CLA 2012-08-01 12:48:42 EDT
(In reply to comment #17)
> I think it is just the build.properties change, but CCing David to correct
> me if wrong.

build.properties would be the first step. There _might_ be some build.properties files for features that we'd want to change. I'm not sure if the build will FAIL if a listed bundle is not found, ... or ... just quietly ignore a missing source bundle. But in either case, we'd want to be sure it was accurate, for clarity if nothing else. 

For example, the master-equinox feature is what currently builds the equinox source feature and it has: 


generate.feature@org.eclipse.equinox.source=org.eclipse.equinox,\
  plugin@javax.servlet.jsp.source;version=2.2.0.qualifier;unpack="false",\
  plugin@apache.jasper.glassfish.source;version=2.2.2.qualifier;unpack="false",\
  plugin@org.apache.commons.el.source;version=1.0.0.qualifier;unpack="false",\
  plugin@javax.servlet.source;version=3.0.0.qualifier;unpack="false",\
  plugin@org.apache.commons.logging.source;version=1.0.4.qualifier;unpack="false",\
  plugin@org.eclipse.jetty.continuation.source;version=8.1.3.qualifier;unpack="false",\
  plugin@org.eclipse.jetty.http.source;version=8.1.3.qualifier;unpack="false",\
  plugin@org.eclipse.jetty.io.source;version=8.1.3.qualifier;unpack="false",\
  plugin@org.eclipse.jetty.security.source;version=8.1.3.qualifier;unpack="false",\
  plugin@org.eclipse.jetty.server.source;version=8.1.3.qualifier;unpack="false",\
  plugin@org.eclipse.jetty.servlet.source;version=8.1.3.qualifier;unpack="false",\
  plugin@org.eclipse.jetty.util.source;version=8.1.3.qualifier;unpack="false",\
  plugin@javax.el.source;version=2.2.0.qualifier;unpack="false"
Comment 19 Thomas Watson CLA 2012-09-05 10:40:13 EDT
Not going to make SR1.
Comment 20 Paul Webster CLA 2012-09-19 14:48:12 EDT
Thanh, what needs to be done here?  did this change make it in with our non-POM changes recently?

PW
Comment 21 Thanh Ha CLA 2012-09-19 15:06:15 EDT
(In reply to comment #20)
> Thanh, what needs to be done here?  did this change make it in with our
> non-POM changes recently?
> 
> PW

Yes this change already made it in.

http://git.eclipse.org/c/equinox/rt.equinox.framework.git/commit/?h=R3_8_maintenance&id=ec1a05c78a3626e3f900596dd95842731e529e60


Marking this bug as resolved.