[yum-commits] Branch 'yum-3_2_X' - docs/comps.rng
Jeremy Katz
katzj at osuosl.org
Fri Jul 10 15:49:31 UTC 2009
docs/comps.rng | 275 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 275 insertions(+)
New commits:
commit 50cfecca2100a4e762b267c0520da42403a62e5e
Author: Jeremy Katz <katzj at redhat.com>
Date: Fri Jul 10 11:45:41 2009 -0400
Add relax-ng schema for comps and have it installed
diff --git a/docs/comps.rng b/docs/comps.rng
new file mode 100644
index 0000000..b681bfb
--- /dev/null
+++ b/docs/comps.rng
@@ -0,0 +1,275 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Comps file Relax-NG Schema
+
+ © 2006 Nicolas Mailhot <nim at fedoraproject dot org>
+
+ TODO: re-add namespace to this file
+ use that namespace to comps.xml files
+ create grammar for comps.xml.in
+ add more documentation for comps elements
+-->
+<grammar xmlns="http://relaxng.org/ns/structure/1.0"
+ xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0"
+ datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+ <start>
+ <ref name="comps"/>
+ </start>
+ <define name="comps">
+ <element name="comps">
+ <oneOrMore>
+ <ref name="group"/>
+ </oneOrMore>
+ <zeroOrMore>
+ <ref name="category"/>
+ </zeroOrMore>
+ <optional>
+ <interleave><!-- We don't care what order these are in -->
+ <ref name="whiteout"/>
+ <ref name="blacklist"/>
+ </interleave>
+ </optional>
+ </element>
+ </define>
+ <define name="group">
+ <element name="group">
+ <!-- Example documentation. Please add more. -->
+ <a:documentation>This defines a package group.</a:documentation>
+ <interleave>
+ <ref name="id"/>
+ <element name="default" a:defaultValue="true">
+ <a:documentation>Should the group be enabled by default?</a:documentation>
+ <ref name="boolean"/>
+ </element>
+ <element name="uservisible" a:defaultValue="true">
+ <a:documentation>Should the group be visible to users?</a:documentation>
+ <ref name="boolean"/>
+ </element>
+ <optional>
+ <element name="display_order">
+ <ref name="positiveInteger"/>
+ </element>
+ </optional>
+ <optional>
+ <element name="langonly">
+ <ref name="locale"/>
+ </element>
+ </optional>
+ <optional>
+ <ref name="groupreqlist"/>
+ </optional>
+ <ref name="packagelist"/>
+ </interleave>
+ </element>
+ </define>
+ <define name="groupreqlist">
+ <a:documentation>
+ Contains a list of other groups that this group requires.
+ This element has been ignored by yum et. al. since 2005 and should
+ therefore be considered deprecated.
+ </a:documentation>
+ <element name="grouplist">
+ <oneOrMore>
+ <ref name="groupreq"/>
+ </oneOrMore>
+ </element>
+ </define>
+ <define name="groupreq">
+ <element name="groupreq">
+ <ref name="groupname"/>
+ </element>
+ </define>
+ <define name="packagelist">
+ <element name="packagelist">
+ <oneOrMore>
+ <ref name="packagereq"/>
+ </oneOrMore>
+ </element>
+ </define>
+ <define name="packagereq">
+ <element name="packagereq">
+ <choice>
+ <attribute name="type" a:defaultValue="optional">
+ <choice>
+ <value>mandatory</value>
+ <value>default</value>
+ <value>optional</value>
+ </choice>
+ </attribute>
+ <group>
+ <attribute name="type" a:defaultValue="conditional">
+ <choice>
+ <value>conditional</value>
+ </choice>
+ </attribute>
+ <attribute name="requires">
+ <ref name="packagename"/>
+ </attribute>
+ </group>
+ </choice>
+ <optional>
+ <attribute name="basearchonly" a:defaultValue="false">
+ <ref name="boolean"/>
+ </attribute>
+ </optional>
+ <ref name="packagename"/>
+ </element>
+ </define>
+ <define name="category">
+ <element name="category">
+ <interleave>
+ <ref name="id"/>
+ <optional>
+ <element name="display_order">
+ <ref name="positiveInteger"/>
+ </element>
+ </optional>
+ <ref name="grouplist"/>
+ </interleave>
+ </element>
+ </define>
+ <define name="grouplist">
+ <element name="grouplist">
+ <oneOrMore>
+ <ref name="groupid"/>
+ </oneOrMore>
+ </element>
+ </define>
+ <define name="groupid">
+ <element name="groupid">
+ <ref name="string"/>
+ </element>
+ </define>
+ <define name="id">
+ <element name="id">
+ <ref name="ID"/>
+ </element>
+ <choice>
+ <!-- Either we have one _name and one _description (comps.xml.in) -->
+ <group>
+ <element name="_name">
+ <ref name="string"/>
+ </element>
+ <element name="_description">
+ <ref name="string"/>
+ </element>
+ </group>
+ <!-- Or we have one name, one description, and then zero-or-more
+ localized names and descriptions following that. -->
+ <group>
+ <element name="name">
+ <ref name="string"/>
+ </element>
+ <zeroOrMore>
+ <element name="name">
+ <attribute name="xml:lang">
+ <ref name="locale"/>
+ </attribute>
+ <ref name="string"/>
+ </element>
+ </zeroOrMore>
+ <element name="description">
+ <ref name="string"/>
+ </element>
+ <zeroOrMore>
+ <element name="description">
+ <attribute name="xml:lang">
+ <ref name="locale"/>
+ </attribute>
+ <ref name="string"/>
+ </element>
+ </zeroOrMore>
+ </group>
+ </choice>
+ </define>
+ <define name="blacklist">
+ <a:documentation>
+ The "blacklist" is a list of packages that will be *removed* if found
+ during an upgrade. Typically this is used to handle tricky upgrade cases
+ that can't be modeled with existing RPM Obsoletes/Conflicts/etc.
+
+ Here's an example: In FC6, hal was a multilib package, but in F7 we split
+ it into (non-multilib) hal and (multilib) hal-libs.
+ So the system starts with hal.x86_64 and hal.i386 (for multilib compat).
+ We want to upgrade to hal.x86_64 and hal-libs.x86_64, with hal-libs.i386
+ for multilib. Upgrading hal.x86_64 will bring in hal-libs.x86_64, and
+ upgrading hal.i386 brings in hal-libs.i386. Adding a blacklist item for
+ 'hal.i386' causes anaconda to remove the (now-unneeded) hal.i386,
+ which gives us the desired outcome.
+ </a:documentation>
+ <element name="blacklist">
+ <zeroOrMore>
+ <element name="package">
+ <attribute name="name">
+ <ref name="string"/>
+ </attribute>
+ <optional>
+ <attribute name="arch">
+ <ref name="string"/>
+ <a:documentation>
+ Arch to blacklist this package from. If unspecified, it will be
+ blocked on all arches.
+ <!-- Technically this should be an enum of known arches:
+ i386 x86_64 ppc ppc64 ia64 sparc alpha ... -->
+ </a:documentation>
+ </attribute>
+ </optional>
+ </element>
+ </zeroOrMore>
+ </element>
+ </define>
+ <define name="whiteout">
+ <a:documentation>
+ The RPM "whiteout" list is used to by RPM to break dependency loops.
+ Each "ignoredep" element has two attributes - "package" and "requires" -
+ which are both package names. While calculating dependencies, RPM will
+ ignore any dependency that results in p requiring r.
+
+ This is used to keep upgrades from getting stuck on known dependency loops,
+ like with mutually dependent packages (e.g. xinitrc and xorg-x11)
+
+ To feed this info to RPM, each item should be converted to a string of the
+ form 'package>requires', and the RPM macro '_dependency_whiteout' should be
+ filled with a (whitespace-separated) list of these items.
+ </a:documentation>
+ <element name="whiteout">
+ <zeroOrMore>
+ <element name="ignoredep">
+ <attribute name="package">
+ <ref name="string"/>
+ </attribute>
+ <attribute name="requires">
+ <ref name="string"/>
+ </attribute>
+ </element>
+ </zeroOrMore>
+ </element>
+ </define>
+ <define name="boolean">
+ <choice>
+ <value>true</value>
+ <value>True</value>
+ <value>false</value>
+ <value>False</value>
+ </choice>
+ </define>
+ <define name="groupname">
+ <data type="string"/>
+ </define>
+ <define name="ID">
+ <data type="ID"/>
+ </define>
+<!-- Should be a regexp -->
+ <define name="locale">
+ <data type="string"/>
+ </define>
+ <define name="packagename">
+ <data type="string"/>
+ </define>
+ <define name="positiveInteger">
+ <data type="positiveInteger"/>
+ </define>
+ <define name="string">
+ <data type="string"/>
+ </define>
+</grammar>
More information about the Yum-commits
mailing list