Difference between revisions of "Equinox p2 Metadata Generator"

From Eclipsepedia

Jump to: navigation, search
Line 9: Line 9:
 
== Arguments describing the input ==
 
== Arguments describing the input ==
  
* -source the path to a folder containing plugins and folders
+
; -source <path> :the path to a folder containing plugins and folders to contain p2 metadata for
* -updateSite
+
; -updateSite <path> :the path of a traditional update site to generator p2 metadata for
* -config
+
; -config <path> :the path of an Eclipse application that is not p2-enabled
* -exe  
+
; -exe <path> :the location of the application launcher executable
* -launcherConfig
+
; -launcherConfig <path> :the path of the launcher configuration file (eclipse.ini)
* -features
+
; -features <path> :the location of features to generate metadata for
* -bundles
+
; -bundles <path> : the location of bundles to generate metadata for
* -base
+
; -base <path> :a base location containing a plugins/ and features/ directory
* -p2.os
+
; -p2.os :the operating system of the application metadata is being generated for
* -site
+
; -site <path> :the path of a site.xml file used to generator categories
 +
 
 
== Arguments describing the output ==
 
== Arguments describing the output ==
  
* -metadataRepository, the URL to a writtable metadata repository that will contain the produced installable units
+
; -metadataRepository :the URL to a writable metadata repository that will contain the produced installable units
* -metadataRepositoryName, a user friendly name for the metadata repository
+
; -metadataRepositoryName :a user friendly name for the metadata repository
* -artifactRepository, the URL to a writtable artifact repository that will contain the produced artifacts
+
; -artifactRepository :the URL to a writable artifact repository that will contain the produced artifacts
* -artifactRepositoryName, a user friendly name for the artifact repository
+
; -artifactRepositoryName :a user friendly name for the artifact repository
* -publishArtifacts, flag indicating whether the artifacts should be published to the repository. When this flag is not set, the actual bytes underlying the artifact will not be copied, but the repository index will be created. When this option is not specified, it is recommended to set the artifactRepository to be in the same location than the source (-source)
+
; -publishArtifacts :flag indicating whether the artifacts should be published to the repository. When this flag is not set, the actual bytes underlying the artifact will not be copied, but the repository index will be created. When this option is not specified, it is recommended to set the artifactRepository to be in the same location than the source (-source)
* -publishArtifactRepository
+
; -publishArtifactRepository
* -append, flag indicating that repositories will be appended to
+
; -append :flag indicating that repositories will be appended to
 
+
; -root :The name of the installable unit referring to all the IUs that have been added to the repository during the run
* -root The name of the IU referring to all the IUs that have been added to the repo during the run.
+
; -rootVersion :The version of the root installable unit
* -rootVersion The version of the IU
+
; -flavor :the flavor associated with the configuration units generated. (This will be removed for 1.0)
 
+
; -inplace :causes the metadata and artifact repositories to be written into the source location
* -flavor, the flavor associated with the configuration units generated. (This will be removed for 1.0)
+
; -noDefaultIUs :flag to indicate the default configuration units should not be created
* -inplace
+
; -compress :cause the repositories to store their index in compressed form
* -noDefaultIUs
+
; -reusePack200Files :publish the existing pack200 files in the repository. This works when the artifact repo is generated in the source.
* -compress cause the repositories to store their index in compressed form
+
* -reusePack200Files publish the existing pack200 files in the repository. This works when the artifact repo is generated in the source.
+
 
+
:word;definition
+
  
 
= Generator Ant Task =
 
= Generator Ant Task =
  
 +
The generator Ant task is called "p2.generator". This task is also available in the org.eclipse.equinox.p2.metadata.generator bundle.
  
 
[[Category:Equinox_p2|Metadata generator]]
 
[[Category:Equinox_p2|Metadata generator]]

Revision as of 00:08, 31 March 2008

The p2 metadata generator is a utility tool that generates metadata and artifact repositories from a given input. The generator is available both as an Eclipse application, and as an Ant task.

Contents

Generator Application

The generator application is contained in bundle org.eclipse.equinox.p2.metadata.generator. This bundle is part of the Eclipse SDK, and is also available in the p2 Admin UI. The generator can be invoked using the generic Eclipse launcher as follows:

eclipse -application org.eclipse.equinox.p2.metadata.generator.EclipseGenerator <generatorArgs>

Arguments describing the input

-source <path> 
the path to a folder containing plugins and folders to contain p2 metadata for
-updateSite <path> 
the path of a traditional update site to generator p2 metadata for
-config <path> 
the path of an Eclipse application that is not p2-enabled
-exe <path> 
the location of the application launcher executable
-launcherConfig <path> 
the path of the launcher configuration file (eclipse.ini)
-features <path> 
the location of features to generate metadata for
-bundles <path> 
the location of bundles to generate metadata for
-base <path> 
a base location containing a plugins/ and features/ directory
-p2.os 
the operating system of the application metadata is being generated for
-site <path> 
the path of a site.xml file used to generator categories

Arguments describing the output

-metadataRepository 
the URL to a writable metadata repository that will contain the produced installable units
-metadataRepositoryName 
a user friendly name for the metadata repository
-artifactRepository 
the URL to a writable artifact repository that will contain the produced artifacts
-artifactRepositoryName 
a user friendly name for the artifact repository
-publishArtifacts 
flag indicating whether the artifacts should be published to the repository. When this flag is not set, the actual bytes underlying the artifact will not be copied, but the repository index will be created. When this option is not specified, it is recommended to set the artifactRepository to be in the same location than the source (-source)
-publishArtifactRepository
-append 
flag indicating that repositories will be appended to
-root 
The name of the installable unit referring to all the IUs that have been added to the repository during the run
-rootVersion 
The version of the root installable unit
-flavor 
the flavor associated with the configuration units generated. (This will be removed for 1.0)
-inplace 
causes the metadata and artifact repositories to be written into the source location
-noDefaultIUs 
flag to indicate the default configuration units should not be created
-compress 
cause the repositories to store their index in compressed form
-reusePack200Files 
publish the existing pack200 files in the repository. This works when the artifact repo is generated in the source.

Generator Ant Task

The generator Ant task is called "p2.generator". This task is also available in the org.eclipse.equinox.p2.metadata.generator bundle.