Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
[epp-dev] Naming convention when externalizing Bundle-Vendor/Bundle-Name of org.eclipse.epp.package.*

Hi fellow package maintainers,

I just filed Bug 498145 [1] with the JEE package about
Bundle-Vendor/Bundle-Name not being properly externalized.

I then went on to check whether any other package had similar issues. It
turns out that, yes, some other do (org.eclipse.epp.package.testing uses
%pluginVendor but defines providerName). Moreover, a lot of packages
don't externalize at all (the org.eclipse.epp.package.java maintained by
me, for example).

Worse, we don't seem to have any clear naming convention:

> egrep -r "Bundle-Vendor|Bundle-Name" *
> packages/org.eclipse.epp.package.android/META-INF/MANIFEST.MF:Bundle-Name: EPP Android Bundle
> packages/org.eclipse.epp.package.android/META-INF/MANIFEST.MF:Bundle-Vendor: Eclipse Packaging Project
> packages/org.eclipse.epp.package.committers/META-INF/MANIFEST.MF:Bundle-Name: %pluginName
> packages/org.eclipse.epp.package.committers/META-INF/MANIFEST.MF:Bundle-Vendor: %providerName
> packages/org.eclipse.epp.package.cpp/META-INF/MANIFEST.MF:Bundle-Name: EPP CPP Bundle
> packages/org.eclipse.epp.package.cpp/META-INF/MANIFEST.MF:Bundle-Vendor: Eclipse Packaging Project
> packages/org.eclipse.epp.package.dsl/META-INF/MANIFEST.MF:Bundle-Name: EPP DSL Bundle
> packages/org.eclipse.epp.package.dsl/META-INF/MANIFEST.MF:Bundle-Vendor: Eclipse Packaging Project
> packages/org.eclipse.epp.package.java/META-INF/MANIFEST.MF:Bundle-Name: EPP Java Package
> packages/org.eclipse.epp.package.java/META-INF/MANIFEST.MF:Bundle-Vendor: Eclipse Packaging Project
> packages/org.eclipse.epp.package.javascript/META-INF/MANIFEST.MF:Bundle-Name: %pluginName
> packages/org.eclipse.epp.package.javascript/META-INF/MANIFEST.MF:Bundle-Vendor: %pluginVendor
> packages/org.eclipse.epp.package.javascript.tests/META-INF/MANIFEST.MF:Bundle-Name: EPP JavaScript and Web Package Tests
> packages/org.eclipse.epp.package.javascript.tests/META-INF/MANIFEST.MF:Bundle-Vendor: Eclipse Packaging Project
> packages/org.eclipse.epp.package.jee/META-INF/MANIFEST.MF:Bundle-Name: %Bundle-Name
> packages/org.eclipse.epp.package.jee/META-INF/MANIFEST.MF:Bundle-Vendor: %Bundle-Vendor
> packages/org.eclipse.epp.package.jee/OSGI-INF/l10n/bundle.properties:Bundle-Name = Java EE IDE
> packages/org.eclipse.epp.package.jee/OSGI-INF/l10n/bundle.properties:Bundle-Vendor = Eclipse Packaging Project
> packages/org.eclipse.epp.package.modeling/META-INF/MANIFEST.MF:Bundle-Name: EPP Modeling Bundle
> packages/org.eclipse.epp.package.modeling/META-INF/MANIFEST.MF:Bundle-Vendor: Eclipse Packaging Project
> packages/org.eclipse.epp.package.parallel/META-INF/MANIFEST.MF:Bundle-Name: EPP Parallel Bundle
> packages/org.eclipse.epp.package.parallel/META-INF/MANIFEST.MF:Bundle-Vendor: Eclipse Packaging Project
> packages/org.eclipse.epp.package.php/META-INF/MANIFEST.MF:Bundle-Name: EPP PHP Package
> packages/org.eclipse.epp.package.php/META-INF/MANIFEST.MF:Bundle-Vendor: Eclipse Packaging Project
> packages/org.eclipse.epp.package.rcp/META-INF/MANIFEST.MF:Bundle-Name: EPP RCP/RAP Bundle
> packages/org.eclipse.epp.package.rcp/META-INF/MANIFEST.MF:Bundle-Vendor: Eclipse Packaging Project
> packages/org.eclipse.epp.package.reporting/META-INF/MANIFEST.MF:Bundle-Name: EPP Reporting Bundle
> packages/org.eclipse.epp.package.reporting/META-INF/MANIFEST.MF:Bundle-Vendor: Eclipse Packaging Project
> packages/org.eclipse.epp.package.scout/META-INF/MANIFEST.MF:Bundle-Name: %pluginName
> packages/org.eclipse.epp.package.scout/META-INF/MANIFEST.MF:Bundle-Vendor: %pluginVendor
> packages/org.eclipse.epp.package.testing/META-INF/MANIFEST.MF:Bundle-Name: %pluginName
> packages/org.eclipse.epp.package.testing/META-INF/MANIFEST.MF:Bundle-Vendor: %pluginVendor

What about establishing such a convention here on this list? Once agreed
on, I'd be willing to push a patch to Gerrit.

Personally, I'd prefer %Bundle-Vendor and Bundle-Name over %pluginVendor
and %pluginVendor, as the former is what Plug-in Tools > Externalize
Strings does. Also, the mapping between OSGi header and property key is
really straight-forward.

WDYT?

Andreas

[1] <https://bugs.eclipse.org/bugs/show_bug.cgi?id=498145>

-- 
Codetrails GmbH
The knowledge transfer company

Robert-Bosch-Str. 7, 64293 Darmstadt
Phone: +49-6151-276-7092
Mobile: +49-170-811-3791
http://www.codetrails.com/

Managing Director: Dr. Marcel Bruch
Handelsregister: Darmstadt HRB 91940


Back to the top