Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Tycho/category.xml"
< Tycho
(add to Tycho category (because this is already a somewhat useful documentation)) |
(Added dynamic category example) |
||
Line 29: | Line 29: | ||
<description>Details on the category</description> | <description>Details on the category</description> | ||
</category-def> | </category-def> | ||
+ | |||
+ | <!-- example for a dynamic category --> | ||
+ | <category-def name="javax" label="Bundles starting with javax."/> | ||
+ | <iu> | ||
+ | <category name="javax"/> | ||
+ | <query><expression type="match">id ~= /javax.*/</expression></query> | ||
+ | </iu> | ||
</site> | </site> | ||
</pre> | </pre> |
Revision as of 16:45, 25 February 2015
A category.xml file can be used to include content into a p2 repository and to specify how to display the content in the p2 installation dialog. For it to be used by a Tycho build, it needs to be placed into the root of an eclipse-repository project.
The category.xml format was originally defined by the Eclipse PDE project. There are extensions to the format only supported by p2 and Tycho.
Format overview
Stub category.xml file:
<?xml version="1.0" encoding="UTF-8"?> <site> <feature id="feature.id" version="1.4.100.v2009"/> <bundle id="bundle.id" version="1.3.1.v2013"/> <iu id="unit.id"/> <iu> <query> <expression type="match"> <![CDATA[ id == $0 ]]> </expression> <param>another.unit.id</param> </query> </iu> <feature id="feature.in.category"> <category name="category.id"/> </feature> <category-def name="category.id" label="Category Label"> <description>Details on the category</description> </category-def> <!-- example for a dynamic category --> <category-def name="javax" label="Bundles starting with javax."/> <iu> <category name="javax"/> <query><expression type="match">id ~= /javax.*/</expression></query> </iu> </site>
Including artifacts
TODO details on feature, bundle, and iu (since Tycho 0.23.0) elements
Categorizing content
TODO details on category-def and category elements