From 9d6e6241954d001a5b49e4ea9a48c10e2a792958 Mon Sep 17 00:00:00 2001 From: "Chris St. Pierre" Date: Mon, 10 Dec 2012 17:19:54 -0600 Subject: generate XML schema docs from XML schemas themselves --- schemas/pkgtype.xsd | 316 +++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 286 insertions(+), 30 deletions(-) (limited to 'schemas/pkgtype.xsd') diff --git a/schemas/pkgtype.xsd b/schemas/pkgtype.xsd index cbee6f317..18eda88ab 100644 --- a/schemas/pkgtype.xsd +++ b/schemas/pkgtype.xsd @@ -13,48 +13,304 @@ schemaLocation="genshi.xsd"/> - - - - + + + Abstract description of a package or package group to be + installed. + + + + + + Install the named package. Either ``name`` or + :xml:attribute:`PackageStructure:group` must be specified. + + + + + + + Install the named package group. Package groups are only + supported for Yum :xml:element:`Source` repositories, and + only if the :ref:`yum libraries + <native-yum-libraries>` are in use. Either ``group`` + or :xml:attribute:`PackageStructure:name` must be specified. + + + + + + + Whether or not to verify the package. + + + + + + + The package set to select from a given package group. Only + meaningful if :xml:attribute:`PackageStructure:group` is + specified. + + + + + + Concrete specification of a package to be installed. A + package can be specified in one of two ways: + + * A single Package tag that lists all of the attributes for + the single instance of the package that should be installed. + + * A Package tag with any number of :xml:element:`Instance` + children, each of which lists the attributes of an instance + of the package that should be installed. In this case, the + Package tag should only have + :xml:attribute:`PackageType:name` and + :xml:attribute:`PackageType:type`. + + Note that many of the attributes listed below are specific to + one or a few package drivers. + + + + + An Instance element describes a single instance of a + package that may have several different versions, arches, + etc., installed at once. + + - - - - - - - - - - + + + + The architecture of the package to be installed. + + + + + + + The epoch of the package to be installed. + + + + + + + The version of the package to be installed. See + :xml:attribute:`PackageType:version` for details. + + + + + + + The release of the package to be installed. + + + + + + + Package file name. No name parsing is performed, so no + extra fields get set. This is only used for manual + maintenance of ``gpg-pubkey`` packages with the + :ref:`YUM, YUM24, or RPM <client-tools-yum>` + driver. + + + + + + + Whether or not to perform full package verification (file + integrity, etc.) on this package with the :ref:`YUM, YUM24, + or RPM <client-tools-yum>` driver. + + + + + + + Comma-separated list of flags to pass to the package + verification routines of the :ref:`YUM, YUM24, or RPM + <client-tools-yum>` driver. See ``man rpm`` for + details on the flags. + + + + + + + If this is set to any value other than "install", + package installation will be suppressed with the + :ref:`YUM24 and RPM <client-tools-yum>` drivers. + + + + + + + If this is set to any value other than "upgrade", a + package that has the incorrect version installed will + not be fixed with the :ref:`YUM24 and RPM + <client-tools-yum>` drivers. Note that + "upgrade" is misleading; if a package is installed + that is newer than the desired version, it will not be + downgraded if this attribute is set to anything other + than "upgrade". + + + + + + + If this is set to any value other than "reinstall", a + package that fails package verification will not be + reinstalled with the :ref:`YUM24 and RPM + <client-tools-yum>` drivers. + + + - - - - - - - - - - - - - - - + + + + Package name. + + + + + + + The architecture of the package to be installed. + + + + + + + The version of the package to be installed. This should + *only* be the version, i.e., not the release. Release should + be specified in :xml:attribute:`PackageType:release`, and it + is an error to append the release to this. + + This can also be one of two "special" values: + + * ``auto`` will select the newest version of the package + available. + * ``any`` will select any version of the package, and can be + used to ensure that a package is installed without + requiring any particular version. + + + + + + + The release of the package to be installed. + + + + + + + Package file name. Several other attributes (name, version) + can be automatically defined based on regular expressions + defined in the :ref:`server-plugins-generators-pkgmgr` + plugin, which is the only plugin with which this is useful. + + + + + + + Whether or not to perform package verification. This is not + supported by the :ref:`YUM <client-tools-yum>` driver. + + + + + + + Package file name. No name parsing is performed, so no extra + fields get set. This is only used for some edge cases with + :ref:`server-plugins-generators-pkgmgr`. + + + + + + + Comma-separated list of architectures of this package that + should be installed. This is only used by the + :ref:`server-plugins-generators-pkgmgr` plugin. + + + + + + + Filename creation rules for multiarch packages. This is only + used by the :ref:`server-plugins-generators-pkgmgr` plugin. + + + + + + + The package type, which determines which client driver will + handle installation of this package. + + + + + + + The name of the package for installing (as opposed to the + name when verifying) with the Blast and OpenCSW drivers. + + + + + + + Whether or not to perform basic package checks (version, + release, etc.) on this package with the :ref:`YUM, YUM24, or + RPM <client-tools-yum>` driver. + + + + + + + Whether or not to perform full package verification (file + integrity, etc.) on this package with the :ref:`YUM, YUM24, + or RPM <client-tools-yum>` driver. + + + + + + + Flags to pass to the package verification routines of the + :ref:`YUM, YUM24, or RPM <client-tools-yum>` driver. + + + -- cgit v1.2.3-1-g7c22