Bug 264741 - [doc] Document the p2.repo2runnable task
Summary: [doc] Document the p2.repo2runnable task
Status: RESOLVED FIXED
Alias: None
Product: Equinox
Classification: Eclipse Project
Component: p2 (show other bugs)
Version: 3.5   Edit
Hardware: PC Mac OS X - Carbon (unsup.)
: P3 normal (vote)
Target Milestone: 3.5 RC4   Edit
Assignee: Andrew Niefer CLA
QA Contact:
URL:
Whiteboard:
Keywords: Documentation
Depends on:
Blocks:
 
Reported: 2009-02-12 13:15 EST by Pascal Rapicault CLA
Modified: 2009-06-03 22:28 EDT (History)
5 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-02-12 13:15:44 EST
We need to document the p2.repo2runnable task. There is some information about it in bug #260582
Comment 1 DJ Houghton CLA 2009-02-13 09:34:58 EST
For reference, here is a test file that I have been using.

<project name="test repo transformer" default="run">

	<target name="run">
		<property name="source" value="jar:file:D:\temp\zzz.repo.zip!/" />
		<property name="destination" value="d:/temp/zzz.dest" />

		<p2.repo2runnable source="${source}" destination="${destination}" />
		<!--

		<p2.repo2runnable source="${source}" destination="${destination}">
			<iu id="aBundle" version="1" />
			<iu id="aDirectoryBundle" version="1" />
		</p2.repo2runnable>

		<p2.repo2runnable destination="${destination}">
			<iu id="aBundle" version="1" />
			<iu id="aDirectoryBundle" version="1" />
			<source location="${source}" />
		</p2.repo2runnable>

		<p2.repo2runnable destination="${destination}" >
			<iu id="aBundle" version="1" />
			<iu id="aDirectoryBundle" version="1" />
			<source location="${source}" />
			<source location="${source.2}" />
		</p2.repo2runnable>

		<p2.repo2runnable destination="${destination}" >
			<source location="${source}" />
			<source location="${source.2}" />
		</p2.repo2runnable>

		<p2.repo2runnable destination="${destination}">
			<iu id="aBundle" version="1" />
			<iu id="aDirectoryBundle" version="1" />
			<source dir="d:/temp/zzz/" includes="*" />
		</p2.repo2runnable>
		-->

		<!--
		<p2.repo2runnable destination="${destination}" >
			<source dir="d:/temp/zzz/" includes="*"/>
		</p2.repo2runnable>
		-->

	</target>

</project>
Comment 2 DJ Houghton CLA 2009-05-06 16:13:13 EDT
Martin, saw your note on equinox-dev. Documentation for this is on the todo list. 
Comment 3 DJ Houghton CLA 2009-05-25 10:00:28 EDT
*** Bug 277504 has been marked as a duplicate of this bug. ***
Comment 4 Nick Boldt CLA 2009-05-25 11:13:53 EDT
The task is already documented (partially) here:

http://wiki.eclipse.org/Equinox/p2/Ant_Tasks

Can you document the commandline application too? I can't get it to run headlessly despite suggestions from Andrew and DJ. What flag is used to define the "destination artifact repository location" ??
Comment 5 DJ Houghton CLA 2009-06-01 14:09:21 EDT
Andrew has released some doc on this and the other p2 Ant tasks.
Comment 6 Nick Boldt CLA 2009-06-02 02:40:48 EDT
(In reply to comment #5)
> Andrew has released some doc on this and the other p2 Ant tasks.

Dare I ask where? (You guys *do* like to make us hunt for documentation, don't you?) :P
Comment 7 DJ Houghton CLA 2009-06-02 09:30:55 EDT
In the Help system in last night's build.

Platform Plug-in Developer Guide
Programmer's Reference
Provisioning Platform, p2
Repository Management
Ant Tasks for managing repositories

We can't hand everything to you on a silver platter. :-)
Comment 8 Nick Boldt CLA 2009-06-02 13:10:06 EDT
(In reply to comment #7)
> In the Help system in last night's build.

Ah, I see. 

For a quick reference to the commandline arguments, download a 160M SDK and look in the help system. Makes sense. 

(I guess I'm used to googling the wiki in seconds rather than waiting to dl & install a whole new SDK just for some quick help docs.)

/me wonders if my usecase is special...

Anyway, thanks, I guess I'll check out the new docs the next time I upgrade my platform to a newer RC or the GM. 

Kudos on encouraging an agile response from your users. :P
Comment 9 Andrew Niefer CLA 2009-06-02 13:23:50 EDT
(In reply to comment #8)
> For a quick reference to the commandline arguments, download a 160M SDK and
> look in the help system. Makes sense. 
> 
> (I guess I'm used to googling the wiki in seconds rather than waiting to dl &
> install a whole new SDK just for some quick help docs.)
> 
> /me wonders if my usecase is special...

Its rough living on the edge.  I expect docs will be on help.eclipse.org as usual once the release is finished.

I'm sure you realize that everyone is very busy.  Writing code comes before writing docs and wikis.  And now that we are effectively have run out of time for code, writing real docs comes before wikis.  Poor wikis, destined to be eternally incomplete and out of date.
Comment 10 Nick Boldt CLA 2009-06-02 15:37:54 EDT
> Writing code comes before
> writing docs and wikis.  And now that we are effectively have run out of time
> for code, writing real docs comes before wikis. 

Really, doc and code ought to be done in parallel. 

> Poor wikis, destined to be
> eternally incomplete and out of date.

With wiki2html converters, you could start easily in the wiki and generate the help doc from it. I know of at least 2 websites and 2 eclipse plugins that provide this service.

Anyway, I've updated the wiki with some working examples of commandline usage.

http://wiki.eclipse.org/Equinox/p2/Ant_Tasks#Repo2Runnable

Comment 11 John Arthorne CLA 2009-06-03 22:28:31 EDT
Documentation for repo2runnable has been released:

org.eclipse.pde.doc.user/whatsNew - pde_whatsnew.htm
org.eclipse.platform.doc.isv/guide - p2_repositorytasks.htm