From: Marius Mauch Date: Tue, 9 Oct 2007 19:21:03 +0000 (-0000) Subject: Start documentation of set handler classes X-Git-Tag: v2.2_pre1~670 X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=eb9625664f185d2c976bb1ac6b476a5a6de21103;p=portage.git Start documentation of set handler classes svn path=/main/trunk/; revision=8025 --- diff --git a/doc/config/sets.docbook b/doc/config/sets.docbook index 5657b2cdc..d0612cb1a 100644 --- a/doc/config/sets.docbook +++ b/doc/config/sets.docbook @@ -44,7 +44,10 @@ The configuration of a single set can be very simple as in most cases it only requires a single option class to be - complete. That option defines which handler class should be used to + complete Technically the class option + isn't stricly required, but it should always be used as the default + handler might be changed in future versions. + That option defines which handler class should be used to create the set. Another universal option available for single sets is name, however it's usually not needed as the name of the set is generated from the section name if name @@ -111,4 +114,170 @@ + + Available Set Handler Classes + + The following sections contain the available handler classes that can be + used for the class option in + sets.conf, together with a description about required + and optional configuration options for single and multi set configurations. + Note that not all classes support both configuration styles. + + + + portage.sets.files.StaticFileSet + + This class implements a simple file based package set. All atoms from + configured file are used to form the set, and currently only simple and + versioned atoms are supported (no use conditionals or any-of constructs). + For descriptive purposes the file can be accompanied by a file with the + same name plus a .metadata suffix which can contain + metadata sections for description, author, location and so on. Each section + has the form key: value where value + can contain multiple lines. Therefore sections have to be separated by + blank lines. For example: + + description: This is a somewhat + longer description than usual. So it + needs more than one line. + + homepage: http://www.foobar.org + + author: John Doe <john@doe.com> + + + + + Single Set Configuration + + In a single set configuration this class supports the following options: + + filename: Required. Specifies the path to the file + that should be used for the package set. + + + + + + Multi Set Configuration + + In a multi set configuration this class supports the following options: + + directory: Optional, defaults to + /etc/portage/sets. Specifies the path to a directory + containing package set files. For each file (excluding metadata files) in + that location a separate package set is created. + + name_pattern: Optional, defaults to + sets/$name. This describes the naming pattern + to be used for creating the sets. It must contain either + $name or ${name}, which + will be replaced by the filename (without any directory components). + + + + + + + + portage.sets.files.ConfigFileSet + + Similar to StaticFileSet, but uses Portage configuration files. + Namely it can work with package.use, + package.keywords, package.mask + and package.unmask. It does not support + .metadata files, but ignores the extra data (like + USE flags or keywords) typically found in those files. + + + + Single Set Configuration + + In a single set configuration this class supports the following options: + + filename: See + StaticFileSet + + + + + + + Multi Set Configuration + + In a multi set configuration this class supprts the following options: + + directory: Optional, defaults to + /etc/portage. Specifies the path to a directory + containing one or more of the following portage configuration files: + package.use, package.keywords, + package.mask or package.unmask. + No other files in that directory will be used. + + name_pattern: Optional, defaults to + sets/package_$suffix. This describes the naming + pattern to be used for creating the sets. It must contain either + $suffix or ${suffix}, + which will be replaced by the file suffix (e.g. + use or mask). + + + + + + + + portage.sets.files.WorldSet + + + + + + portage.sets.profiles.PackagesSystemSet + + + + + + portage.sets.security.SecuritySet + + + + + + portage.sets.security.NewGlsaSet + + + + + + portage.sets.security.NewAffectedSet + + + + + + portage.sets.security.AffectedSet + + + + + + portage.sets.shell.CommandOutputSet + + + + + + portage.sets.dbapi.CategorySet + + + + + + portage.sets.dbapi.EverythingSet + + + +