Bug 269128 - [doc] Update old doc with how it relates to p2.
Summary: [doc] Update old doc with how it relates to p2.
Status: RESOLVED FIXED
Alias: None
Product: Equinox
Classification: Eclipse Project
Component: p2 (show other bugs)
Version: 3.5   Edit
Hardware: PC All
: P3 normal (vote)
Target Milestone: 3.5 RC4   Edit
Assignee: P2 Inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords: Documentation
Depends on:
Blocks:
 
Reported: 2009-03-17 23:48 EDT by Pascal Rapicault CLA
Modified: 2009-06-03 22:26 EDT (History)
4 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Pascal Rapicault CLA 2009-03-17 23:48:09 EDT
Platform Plug-in Developer Guide > Reference > Other reference information> for Feature Manifest,  Update server site map, Plug-in manifest should be updated for compatibility with p2.
Comment 1 James D. Miles CLA 2009-05-01 09:39:19 EDT
In Platform Plug-in Developer Guide > Reference > Other reference information
> Feature Manifest
<!ATTLIST plugin 
    unpack        (true | false) "true" 

Default should be "false"
Comment 2 David Williams CLA 2009-05-01 10:58:09 EDT
(In reply to comment #1)
> In Platform Plug-in Developer Guide > Reference > Other reference information
> > Feature Manifest
> <!ATTLIST plugin 
>     unpack        (true | false) "true" 
> 
> Default should be "false"
> 

From a mailing list discussion, there seems to be some confusion about default for the wizard, and default for the schema. The wizard defaults to setting the field to "false", but that's different than the schema defaulting to "true". The schema defaulting to "true" means if there is no attribute, the default will be to unpack ... and that was (and is) required behavior to maintain compatibility with old feature.xml files that existed before there was this attribute (and before, even, jars were packed at all). 

The wizard, on the other hand, is ok to default to 'false' so it encourages best practice ... which would be the desired behavior on anything new. 

Comment 3 James D. Miles CLA 2009-05-01 11:23:33 EDT
No there is no confusion. Here was the original question.
"The feature manifest has a "unpack" attribute on the plugin element. According to the DTD the default is true. But what happens is the opposite. Is this a bug for the code or the doc?"

This question does not refer to the wizard. The test was made with the following
  <plugin
         id="com.test.F121.plugin.unpack_default"
         download-size="0"
         install-size="0"
         version="0.0.0"/>

   <plugin
         id="com.test.F122.plugin.unpack_true"
         download-size="0"
         install-size="0"
         version="0.0.0"
         unpack="true"/>

   <plugin
         id="com.test.F123.plugin.unpack_false"
         download-size="0"
         install-size="0"
         version="0.0.0"
         unpack="false"/>

In the case the only plugin that was unpacked was com.test.F122.plugin.unpack_true
Comment 4 James D. Miles CLA 2009-05-01 11:28:47 EDT
So if the doc must remain with a default behavior of unpack="true" then I will open a bug.
Comment 5 John Arthorne CLA 2009-05-01 13:18:07 EDT
James, can you enter a bug? I would like to investigate to make sure we didn't introduce an accidental change here.
Comment 6 James D. Miles CLA 2009-05-01 13:51:28 EDT
I have opened bug 274672 for the unpack problem.
Comment 7 John Arthorne CLA 2009-06-03 22:26:36 EDT
I have made some minor updates to the feature manifest specification. Mainly, I marked install-handlers, colocation-affinity, and "primary" as deprecated.

I don't know of any changes that need to be made to the plugin manifest spec.

For "Update server site map", I have just deleted this page from the doc. It was specifying the site.xml format. Not only is this repository format obsolete, but the actual format of the file isn't important for users - they can just use the PDE tools or various ant tasks / applications for authoring repositories, without needing to know the details of the file formats. As a replacement I have updated guide/product_update.htm, which talks about the format of a software site at a higher level (describing the layout and expected files, without going into detail on file formats).