Imported Upstream version 0.6.29
[platform/upstream/libsolv.git] / doc / libsolv-constantids.txt
index 7e4f885..907a7e5 100644 (file)
@@ -1,15 +1,15 @@
-LIBSOLV-CONSTANTIDS(3)
+Libsolv-Constantids(3)
 ======================
 :man manual: LIBSOLV
 :man source: libsolv
 
 
-NAME
+Name
 ----
 libsolv-constantids - fixed Ids for often used strings
 
 
-DESCRIPTION
+Description
 -----------
 Constant Ids are Ids of strings that are often needed. They are defined
 to ease programming and reduce the number of pool_str2id calls. The
@@ -20,7 +20,7 @@ fixed Ids, but instead references the strings, so solv files can still
 be read when the ABI is broken.
 
 
-SPECIAL STRINGS
+Special Strings
 ---------------
 *ID_EMPTY ""*::
   The empty string. It will always have Id 1.
@@ -29,11 +29,11 @@ SPECIAL STRINGS
   The name of the always installed "system" solvable.
 
 
-SOLVABLE ATTRIBUTES
+Solvable Attributes
 -------------------
 These are Ids for keyname of attributes. They can be used in the
 lookup and storage functions to select the correct attribute in the
-solvable. The describtions below describe the intended semantics
+solvable. The descriptions below describe the intended semantics
 of the values stored in the attribute with the keyname.
 
 *SOLVABLE_NAME "solvable:name"*::
@@ -71,7 +71,7 @@ of the values stored in the attribute with the keyname.
 *SOLVABLE_RECOMMENDS "solvable:recommends"*::
   Stores an array of dependency Ids that describe the capabilities that
   also should be installed when this package is installed. It's not an
-  error if not all capabilites can be met.
+  error if not all capabilities can be met.
 
 *SOLVABLE_SUGGESTS "solvable:suggests"*::
   Stores an array of dependency Ids that describe the capabilities that
@@ -118,7 +118,7 @@ of the values stored in the attribute with the keyname.
   list of keyword string IDs used for tagging this package.
 
 *SOLVABLE_LICENSE "solvable:license"*::
-  The jicense of this package.
+  The license(s) of this package.
 
 *SOLVABLE_BUILDTIME "solvable:buildtime"*::
   The seconds since the unix epoch when the binary package was created.
@@ -226,8 +226,8 @@ of the values stored in the attribute with the keyname.
   The text of a changelog entry.
 
 
-SPECIAL SOLVABLEATTRIBUTES
---------------------------
+Special Solvable Attributes
+---------------------------
 *RPM_RPMDBID "rpm:dbid"*::
   The rpm database id of this (installed) package. Usually a small
   integer number.
@@ -237,11 +237,11 @@ SPECIAL SOLVABLEATTRIBUTES
   ``update:category'' instead.
 
 *UPDATE_REBOOT "update:reboot"*::
-  If this attribute is present the sytem should be rebooted after
+  If this attribute is present the system should be rebooted after
   the update is installed.
 
 *UPDATE_RESTART "update:restart"*::
-  If this attribute is present the software managemer should be run
+  If this attribute is present the software manager should be run
   again after the update is installed.  
 
 *UPDATE_RELOGIN "update:relogin"*::
@@ -262,16 +262,16 @@ SPECIAL SOLVABLEATTRIBUTES
   The array containing the package list of the update.
   
 *UPDATE_COLLECTION_NAME "update:collection:name"*::
-  The name of the to be updated package.
+  The name of the updated package.
 
 *UPDATE_COLLECTION_EVR "update:collection:evr"*::
-  The version of the to be updated package.
+  The version of the updated package.
 
 *UPDATE_COLLECTION_ARCH "update:collection:arch"*::
-  The architecture of the to be updated package.
+  The architecture of the updated package.
 
 *UPDATE_COLLECTION_FILENAME "update:collection:filename"*::
-  The file name of the to be updated package.
+  The file name of the updated package.
 
 *UPDATE_REFERENCE "update:reference"*::
   The array containing the reference list of the update.
@@ -289,16 +289,16 @@ SPECIAL SOLVABLEATTRIBUTES
   The title of the reference, e.g. the bug summary.
 
 *PRODUCT_REFERENCEFILE "product:referencefile"*::
-  A reference to another product file.
+  The basename of the product file in the package.
 
 *PRODUCT_SHORTLABEL "product:shortlabel"*::
-  A identification string of the product.
+  An identification string of the product.
 
 *PRODUCT_DISTPRODUCT "product:distproduct"*::
-  A SUSE Code-10 product name.
+  Obsolete, do not use. Was a SUSE Code-10 product name.
 
 *PRODUCT_DISTVERSION "product:distversion"*::
-  A SUSE Code-10 product version.
+  Obsolete, do not use. Was a SUSE Code-10 product version.
 
 *PRODUCT_TYPE "product:type"*::
   The type of the product, e.g. ``base''.
@@ -313,24 +313,30 @@ SPECIAL SOLVABLEATTRIBUTES
   An array of product flags.
 
 *PRODUCT_PRODUCTLINE "product:productline"*::
-  A product line string.
+  A product line string used for product registering.
 
 *PRODUCT_REGISTER_TARGET "product:regtarget"*::
-  A target for proudct registering.
+  A target for product registering.
 
 *PRODUCT_REGISTER_RELEASE "product:regrelease"*::
-  A release string for proudct registering.
+  A release string for product registering.
 
 *PUBKEY_KEYID "pubkey:keyid"*::
-  The keyid of a pubkey, consiting of 8 bytes in hex.
+  The keyid of a pubkey, consisting of 8 bytes in hex.
 
 *PUBKEY_FINGERPRINT "pubkey:fingerprint"*::
-  The fingerprint of a pubkey, usualy a sha1sum in hex. Old V3 RSA keys
-  use an md5sum instead.
+  The fingerprint of a pubkey, usually a sha1sum in hex. Old V3 RSA keys
+  use a md5sum instead.
 
 *PUBKEY_EXPIRES "pubkey:expires"*::
   The seconds since the unix epoch when the pubkey expires.
 
+*PUBKEY_SUBKEYOF "pubkey:subkeyof"*::
+  The keyid of the master pubkey for subkeys.
+
+*PUBKEY_DATA "pubkey:data"*::
+  The MPI data of the pubkey.
+
 *SOLVABLE_ISVISIBLE "solvable:isvisible"*::
   An attribute describing if the package should be listed to the user
   or not. Used for SUSE patterns.
@@ -345,7 +351,7 @@ SPECIAL SOLVABLEATTRIBUTES
   A list of other patterns that this pattern extends.
 
 *SOLVABLE_ICON "solvable:icon"*::
-  The icon of a pattern.
+  The icon name of a pattern.
 
 *SOLVABLE_ORDER "solvable:order"*::
   An ordering clue of a pattern.
@@ -363,7 +369,7 @@ SPECIAL SOLVABLEATTRIBUTES
   architecture of the solvable used for sharing attributes.
 
 
-SOLVABLE ARCHITECTURES
+Solvable Architectures
 ----------------------
 Predefined architecture values for commonly used architectures.
 
@@ -371,7 +377,7 @@ Predefined architecture values for commonly used architectures.
   Used for binary packages that contain the package sources.
 
 *ARCH_NOSRC "nosrc"*::
-  Used for binary packages that contain some of thepackage sources,
+  Used for binary packages that contain some of the package sources,
   but not all files (because of restrictions).
 
 *ARCH_NOARCH "noarch"*::
@@ -385,7 +391,7 @@ Predefined architecture values for commonly used architectures.
   and Haiku.
 
 
-DEPENDENCY IDS
+Dependency Ids
 --------------
 Namespaces are special modifiers that change the meaning of a dependency.
 Namespace dependencies are created with the REL_NAMESPACE flag. To make
@@ -394,16 +400,13 @@ custom namespaces work you have to implement a namespace callback function.
 The dependency markers partition the dependency array in two parts with
 different semantics.
 
-*NAMESPACE_INSTALLED "namespace:installed"*::
-  The dependency only selects installed packages.
-
 *NAMESPACE_MODALIAS "namespace:modalias"*::
   The dependency is a special modalias dependency that matches installed
   hardware.
 
 *NAMESPACE_SPLITPROVIDES "namespace:splitprovides"*::
   The dependency is a special splitprovides dependency used to implement
-  updates that include a package split. A splitprovoide dependency contains
+  updates that include a package split. A splitprovides dependency contains
   a filename and a package name, it is matched if a package with the
   provided package name is installed that contains the filename.
   This namespace is implemented in libsolv, so you do not need a callback.
@@ -420,14 +423,10 @@ different semantics.
   This is a hack to allow self-conflicting packages. It is not needed
   with current rpm version, so do not use this namespace.
 
-*NAMESPACE_PRODUCTBUDDY "namespace:productbuddy"*::
-  This is a another hack to implement the SUSE product buddy system.
-  Please ignore.
-
 *SOLVABLE_PREREQMARKER "solvable:prereqmarker"*::
   This marker partitions the normal require dependencies from the
   prerequires. It is not needed for dependency solving, but it is
-  used by the transaction ordering algorthim when a dependency cycle
+  used by the transaction ordering algorithm when a dependency cycle
   needs to be broken (non-prereq deps get broken first).
 
 *SOLVABLE_FILEMARKER "solvable:filemarker"*::
@@ -435,7 +434,7 @@ different semantics.
   synthetic file provides dependencies added by pool_addfileprovides().
 
 
-DATA TYPES
+Data Types
 ----------
 Each attribute data is stored with a type, so that the lookup functions
 know how to interpret the data. The following types are available:
@@ -480,11 +479,11 @@ know how to interpret the data. The following types are available:
   space.
 
 *REPOKEY_TYPE_DIRSTRARRAY "repokey:type:dirstrarray"*::
-  The data is an tuple consisting of a directory Id and a basename.
+  The data is a tuple consisting of a directory Id and a basename.
   Used to store file names.
 
 *REPOKEY_TYPE_DIRNUMNUMARRAY "repokey:type:dirnumnumarray"*::
-  The data is an triple consisting of a directory Id and two 32bit
+  The data is a triple consisting of a directory Id and two 32bit
   unsigned integers. Used to store disk usage information.
 
 *REPOKEY_TYPE_MD5 "repokey:type:md5"*::
@@ -507,7 +506,7 @@ know how to interpret the data. The following types are available:
   The data does not exist. Used to mark an attribute that was deleted.
 
 
-REPOSITORY METADATA
+Repository Metadata
 -------------------
 This attributes contain meta information about the repository.
 
@@ -563,21 +562,22 @@ This attributes contain meta information about the repository.
   in REPOSITORY_UPDATES and REPOSITORY_DISTROS to maximize confusion.
 
 *REPOSITORY_REPOID "repository:repoid"*::
-  An array of Id strings describing this repository.
+  An array of Id strings describing keywords/tags about the repository
+  itself.
 
 *REPOSITORY_KEYWORDS "repository:keywords"*::
-  An array of Id strings describing keywords of this repository.
+  An array of Id strings describing keywords/tags about the content of
+  the repository.
 
 *REPOSITORY_REVISION "repository:revision"*::
-  One or more(?) arbitrary revision strings describing the revision
-  of the repository.
+  An arbitrary string describing the revision of the repository.
 
 *REPOSITORY_TOOLVERSION "repository:toolversion"*::
   Some string describing somewhat the version of libsolv used to create
   the solv file.
 
 
-REPOSITORY METADATA FOR SUSETAGS REPOS
+Repository Metadata for Susetags Repos
 --------------------------------------
 Attributes describing repository files in a susetags repository.
 *SUSETAGS_DATADIR "susetags:datadir"*::
@@ -602,7 +602,7 @@ Attributes describing repository files in a susetags repository.
   The file checksum of the resource.
 
 
-REPOSITORY METADATA FOR RPMMD REPOS
+Repository Metadata for RpmMD Repos
 -----------------------------------
 *REPOSITORY_REPOMD "repository:repomd"*::
   An array of file resources of the repository.
@@ -626,7 +626,7 @@ REPOSITORY METADATA FOR RPMMD REPOS
   The size of the resource file.
 
 
-DELTA PACKAGE ATTRIBUTES
+Delta Package Attributes
 ------------------------
 *DELTA_PACKAGE_NAME "delta:pkgname"*::
   The target package name for the delta package. Applying the delta
@@ -650,6 +650,10 @@ DELTA PACKAGE ATTRIBUTES
 *DELTA_LOCATION_SUFFIX "delta:locsuffix"*::
   The suffix part of the file name of the delta package.
 
+*DELTA_LOCATION_BASE "delta:locbase"*::
+  This attribute can be used to overwrite the repositories base url for
+  the delta.
+
 *DELTA_DOWNLOADSIZE "delta:downloadsize"*::
   The size of the delta rpm file.
 
@@ -657,7 +661,7 @@ DELTA PACKAGE ATTRIBUTES
   The checksum of the delta rpm file.
 
 *DELTA_BASE_EVR "delta:baseevr"*::
-  The version of the package the delta was build against.
+  The version of the package the delta was built against.
 
 *DELTA_SEQ_NAME "delta:seqname"*::
   The first part of the delta sequence, the base package name.
@@ -674,3 +678,6 @@ Author
 ------
 Michael Schroeder <mls@suse.de>
 
+////
+vim: syntax=asciidoc
+////