Re: [orbit-dev] Questions about my first bundle, SWTChart

[David M Williams <david_williams@xxxxxxxxxx>]

I'm glad DJ answered (thanks DJ) ... since this already rolled off the
bottom of my inbox :) ... but, since I saw my name mentioned, I'll confirm
everything DJ said is correct. :)

One small comment about the "import or require" issue. Besides whether or
not there are other implementers of a package, the other advantage of using
"import package" is then you are more immune from future re-factorings, in
this case, if the swt bundle is ever refactored into two or three bundles.
My guess is that it is very unlikely swt will ever refactor that bundle
(not that I would know)  ... but, thought I'd mention it. I'd say if
SWTChart required only one or two packages, it might be worth using "import
package" but, if SWTChart is tightly bound to swt bundle then require
bundle is just fine ... and you'd just have to suffer through future
refactorings anyway (since tightly bound). I'm saying all this just "FYI",
for general education.

Since it is already an existing bundle, it is best (if not very important)
to do it exactly like they do it so our Orbit bundle would behave "exactly
like" any other version, out there in the wild. (There might be exceptions
to this ... but, they'd be rare).

I will add, we have very few cases where Orbit bundles "depend on"
something directly from Eclipse, so be careful (or well document) if there
are any special lower/upper bound constraints. I am 99% sure our build will
handle it just fine as long as required range is not real specific. Since
we do not actually compile things in Orbit, you wouldn't think this would
be an issue, but there are some things done in PDE build to see if all
bundles can be resolved and, honestly, I've been surprised several times in
the past about what it complains about :)  (But, if it does complain, we
can solve it, I'm sure).

I'm assuming you don't need this for M5? If so, better say so explicitly,
since we will be declaring our "S-build" late today or tomorrow. If not
needed for M5, might want to wait till that S-build has been declared, to
not risk breaking the build "at the last minute" (though, I'm sure, we
could revert if you just happened to be working on it today about ready to
drop).

Thanks,





From:	DJ Houghton <DJ_Houghton@xxxxxxxxxx>
To:	Andrew Overholt <overholt@xxxxxxxxxx>, Orbit Developer
            discussion <orbit-dev@xxxxxxxxxxx>,
Date:	01/20/2012 10:28 AM
Subject:	Re: [orbit-dev] Questions about my first bundle, SWTChart
Sent by:	orbit-dev-bounces@xxxxxxxxxxx



Hey Andrew, some quick answers for you:

1). Yes, I believe that's correct.

2). No I wouldn't worry about it. I would think it is uncommon for other
people to implement org.eclipse.swt packages so it makes sense to require
our implementation of those packages and just use a bundle requirement.

3). No, you only need to include a source-bundle folder if you're
distributing the source as well. We have a couple other bundles that don't.
David can confirm but I don't think there is anything special you need to
do. I just quickly checked the source feature generation code and it does a
lookup for the source bundle before creating an entry for it in the source
feature, so it shouldn't create a bogus one for your bundle.

4). No, I think your about.html can look pretty much like any of the
Eclipse Platform about.html files since it is EPL only.

HTH,

dj

orbit-dev-bounces@xxxxxxxxxxx wrote on 2012/01/19 04:48:26 PM:

> From: Andrew Overholt <overholt@xxxxxxxxxx>
> To: orbit-dev@xxxxxxxxxxx
> Date: 2012/01/19 04:49 PM
> Subject: [orbit-dev] Questions about my first bundle, SWTChart
> Sent by: orbit-dev-bounces@xxxxxxxxxxx
>
> Hi,
>
> I'm attempting to submit my first bundle for inclusion in Orbit, SWTChart
> [1].  Going through the "Adding Bundles to Orbit" page, I have a few
> questions:
>
> 1. SWTChart is provided as an OSGi bundle but without Bundle-Vendor or
> license file included.  For this reason I am creating a proper bundle in
> Orbit; is this the right move?
>
> 2. SWTChart uses Require-Bundle: org.eclipse.swt ... should I figure out
> what parts of SWT it's using and change this to Import-Package
statements?
>
> 3. Do I need to have a source-bundle directory?  The CQ was filed
> requesting distribution of the binary only.
>
> 4. Since SWTChart is EPL, do I need the separate blurb at the bottom of
> about.html similar to, for example, Apacho Oro?
>
> Thanks very much,
>
> Andrew
>
> [1]
> http://www.swtchart.org/_______________________________________________
orbit-dev mailing list
orbit-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/orbit-dev