Bug 468690 - Fixed bug 468690: Modify documentation regarding missing Delta pack
Summary: Fixed bug 468690: Modify documentation regarding missing Delta pack
Status: RESOLVED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: Doc (show other bugs)
Version: 4.5   Edit
Hardware: PC Linux
: P3 normal (vote)
Target Milestone: 4.5 RC4   Edit
Assignee: David Williams CLA
QA Contact:
URL:
Whiteboard:
Keywords: Documentation
Depends on:
Blocks:
 
Reported: 2015-05-28 13:34 EDT by David Williams CLA
Modified: 2015-06-02 16:27 EDT (History)
6 users (show)

See Also:


Attachments
patch for minimal changes to remove mention of "Delta Pack" (5.96 KB, patch)
2015-05-28 13:39 EDT, David Williams CLA
no flags Details | Diff
patch that also includes pointer to wiki page (2.37 KB, patch)
2015-05-28 13:49 EDT, David Williams CLA
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description David Williams CLA 2015-05-28 13:34:58 EDT
But 419246 covers "removing the delta pack". 

But the question remains about how to fix the documentation. 

I'll attach a patch of Docs with "minimal changes" needed. It basically substitutes "org.eclipse.equinox.executable feature" where "Delta Pack" used to occur. 

The patch does not change the p2 example of "creating the delta pack" (I think that should remain, as an example for people who do what to "create their own delta pack). 

It also does not change the PDE Build option of "deltaPack" that is in 
pde_packager.htm. Not sure if that should remain, or not. As far as I know, it works ... but ... if we say "we dont' support it" any longer, perhaps should be removed? 

Also, I'd like to leave a pointer to a wiki, that would cover "how to transition is previously used Delta pack". I thought we had the beginnings of one, but all I could find was 
https://wiki.eclipse.org/Building#Using_the_.22DeltaPack.22
which is no longer accurate. 
The place to include such a link, I think, is in
/org.eclipse.pde.doc.user/guide/tools/editors/product_editor/overview.htm
at the very end, in "exporting" section. 
I'll include example, as separate patch, but, since the wiki text does not currently exist, guess we could point to general page, and add sections for "Mars" later? 

= = = = = = = =

Or, alternatively, we could leave doc the same, and make delta pack visible again, but ... the delta pack is not what it used to be, and not sure it works as documented.
Comment 1 David Williams CLA 2015-05-28 13:39:30 EDT
Created attachment 253908 [details]
patch for minimal changes to remove mention of "Delta Pack"

I consider this "minimal change" since all by itself, would not be that helpful, to either new users, or "old friends" used to the Delta Pack. But, would be "the basics". 

I think besides the "executable feature", users would still have to add various fragments (swt, file system fragments, etc.) ... and, I actually think that may be true of "Delta Pack" anyway, the way it is currently built by Tycho? 

So, advice welcome.
Comment 2 David Williams CLA 2015-05-28 13:41:23 EDT
(In reply to David Williams from comment #0)
> But 419246 covers "removing the delta pack". 

Bug 419246 ... that is.
Comment 3 David Williams CLA 2015-05-28 13:49:11 EDT
Created attachment 253909 [details]
patch that also includes pointer to wiki page

This patch includes pointer to the not-yet-updated wiki page, in 'overview' page.
Comment 4 Lars Vogel CLA 2015-05-28 13:52:33 EDT
If we remove the delta pack should we also remove the corresponding functionality from PDE? For example the product configuration editor has a description "Install the delta pack to export to several platforms".
Comment 5 David Williams CLA 2015-05-29 15:42:36 EDT
(In reply to Lars Vogel from comment #4)
> If we remove the delta pack should we also remove the corresponding
> functionality from PDE? For example the product configuration editor has a
> description "Install the delta pack to export to several platforms".

I think the functionality should stay, but I think the wording about "install the delta pack" should be removed. 

(The whole purpose of this is to have people use p2, instead of a separate download, but the functionality *should* still work. I personally don't know enough about it, to get it to work, but adding the executable feature in runtime target is enough to get the checkbox, and list of platforms -- from there, it's just a matter of also adding all the necessary pre-reqs).
Comment 6 Dani Megert CLA 2015-06-02 10:58:22 EDT
(In reply to David Williams from comment #1)
> Created attachment 253908 [details] [diff]
> patch for minimal changes to remove mention of "Delta Pack"

Thanks David. Updated copyright date and submitted with http://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=de0fd2fbf056a004dab0fe2433bf1a6489b6deca
Comment 7 Dani Megert CLA 2015-06-02 10:59:17 EDT
(In reply to David Williams from comment #3)
> Created attachment 253909 [details] [diff]
> patch that also includes pointer to wiki page
> 
> This patch includes pointer to the not-yet-updated wiki page, in 'overview'
> page.

This patch can no longer be applies after committing the first patch.
Comment 8 David Williams CLA 2015-06-02 12:25:51 EDT
Comment on attachment 253909 [details]
patch that also includes pointer to wiki page

Sorry about the "mixed" patch. 

Given your applying the other patch as "approval", I went ahead and committed the 
extra sentence about the wiki page. 

http://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=5e91d798ba187fcf09ea88ae53aba51dc1b05906
Comment 9 David Williams CLA 2015-06-02 12:37:37 EDT
I have opened bug 469178 to remind me to update the wiki page we point to. 

Now ... where's that UI section ...
Comment 10 David Williams CLA 2015-06-02 12:55:05 EDT
I've opened PDE Bug 469180  (with patch) to remove the sentence that mentions 
"Delta pack" specifically.