Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 351461 - Schema should be included in runtime and not source bundle
Summary: Schema should be included in runtime and not source bundle
Status: RESOLVED FIXED
Alias: None
Product: z_Archived
Classification: Eclipse Foundation
Component: Mylyn (show other bugs)
Version: 3.6   Edit
Hardware: PC All
: P3 trivial (vote)
Target Milestone: 3.6.2   Edit
Assignee: Steffen Pingel CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks: 378069
  Show dependency tree
 
Reported: 2011-07-07 10:56 EDT by Alex Blewitt CLA
Modified: 2012-05-01 07:35 EDT (History)
2 users (show)

See Also:


Attachments
mylyn/context/zip (1.37 KB, application/octet-stream)
2011-08-25 11:01 EDT, Steffen Pingel CLA
no flags Details

Note You need to log in before you can comment on or make changes to this bug.
Description Alex Blewitt CLA 2011-07-07 10:56:51 EDT
The build.properties of org.eclipse.mylyn.tasks.bugs lists the schema in the source-only package, not in the binary package. This means you can't validate when you have only installed the binary runtime, when PDE is capable of looking at the binary and extracting the schema from it.

http://dev.eclipse.org/viewcvs/viewvc.cgi/org.eclipse.mylyn.tasks/org.eclipse.mylyn.tasks.bugs/build.properties?view=markup&root=Mylyn_Project

 9  bin.includes = META-INF/,\
10	               plugin.xml,\
11	               about.html,\
12	               .,\
13	               icons/,\
14	               plugin.properties
15	src.includes = about.html,\
16	               schema/

I suggest that the schema is put into the bin.includes, which will allow for validation even if the source isn't present, i.e.

bin.includes = META-INF/,\
	schema,\
	plugin.xml,\
	...
src.includes = about.html

I know the link is to the CVS version (which is probably out of date) but gives an idea of which file to change.
Comment 1 Steffen Pingel CLA 2011-07-15 20:08:45 EDT
That sounds reasonable to me. I have checked platform bundles and they seem to generally only include schemas in source bundles though. Do you happen to know if there is an Eclipse guideline for this?
Comment 2 Steffen Pingel CLA 2011-08-25 11:01:29 EDT
My question on the AC mailing list whether a policy exists didn't yield any response: http://dev.eclipse.org/mhonarc/lists/eclipse.org-architecture-council/msg01618.html . I have hence gone ahead and included the schema.

Generally, I would recommend integrators to add the appropriate Mylyn SDK feature to their target to have access to sources. In this case there is no Java implementation required though so it makes sense to make the schema available in the binary-only distribution as well. Thanks for raising this.
Comment 3 Steffen Pingel CLA 2011-08-25 11:01:32 EDT
Created attachment 202154 [details]
mylyn/context/zip
Comment 4 Martin Oberhuber CLA 2011-09-15 12:44:03 EDT
We discussed this in the AC call today:
http://wiki.eclipse.org/Architecture_Council/Meetings/September_15_2011

General thought was that exsd's in the binary bundles don't hurt. How valuable they are depends on the domain and packaging (how are ISV docs provided? Is source needed for doing anything meaningful with the extensions? How are adopters expected to learn about using the extension points?)

In the Platform Project, the SDK is a package containing all of ISV Docs, source and schemas. But that doesn't mean others have to do it like that. Schemas in binary bundles make sense when extensions can be used to configure a product.

We didn't feel like making a general recommendation for this on the AC, but for sure we're fine with any project adding exsd's into binary bundles.
Comment 5 Steffen Pingel CLA 2011-09-15 15:02:24 EDT
Thanks for the detailed answer. That sounds like a very good approach and we'll follow that for Mylyn making schemas available in binaries that are intended for configuration.

Sorry for missing the call. Unfortunately I didn't update my calendar.