From a30f7649044744abd5493d3b30d6a66b48c462fd Mon Sep 17 00:00:00 2001 From: Marius Mauch Date: Tue, 9 Oct 2007 20:13:46 +0000 Subject: [PATCH] document all options svn path=/main/trunk/; revision=8028 --- doc/config/sets.docbook | 120 +++++++++++++++++++++++++++++++++++++++- 1 file changed, 119 insertions(+), 1 deletion(-) diff --git a/doc/config/sets.docbook b/doc/config/sets.docbook index d0612cb1a..9bda39227 100644 --- a/doc/config/sets.docbook +++ b/doc/config/sets.docbook @@ -24,6 +24,7 @@ alter the default and repository sets. + sets.conf Syntax @@ -70,6 +71,7 @@ + Multi Set Configuration @@ -114,6 +116,7 @@ + Available Set Handler Classes @@ -205,7 +208,7 @@ Multi Set Configuration - In a multi set configuration this class supprts the following options: + In a multi set configuration this class supports the following options: directory: Optional, defaults to /etc/portage. Specifies the path to a directory @@ -229,55 +232,170 @@ portage.sets.files.WorldSet + A minor variation of StaticFileSet, mainly for implementation + reasons. It should never be used in user configurations as it's already configured + by default, doesn't support any options and will eventually be removed in a future version. + + + Single Set Configuraton + + This class does not support any options. + + portage.sets.profiles.PackagesSystemSet + This class implements the classic system set, based on the + packages files in the profile. + + There is no reason to use this in a user configuration as it is already + confgured by default and doesn't support any options. + + + Single Set Configuration + + This class does not support any options. + + portage.sets.security.SecuritySet + + + Single Set Configuration + + This class does not support any options. + + portage.sets.security.NewGlsaSet + + + Single Set Configuration + + This class does not support any options. + + portage.sets.security.NewAffectedSet + + + Single Set Configuration + + This class does not support any options. + + portage.sets.security.AffectedSet + + + Single Set Configuration + + This class does not support any options. + + portage.sets.shell.CommandOutputSet + + + Single Set Configuration + + In single set configurations this class supports the following options: + + command: Required. Specifies the command + that should be executed to generate the package set. + + + + portage.sets.dbapi.CategorySet + + + Single Set Configuration + + In single set configurations this class supports the following options: + + category: Required. The name of an existing ebuild + category which should be used to create the package set. + + repository: Optional, defaults to + porttree. It determines which repository class should + be used to create the package set. Valid values for this option are: + porttree (normal ebuild repository), + vartree (installed package repository) + and bintree (local binary package repository). + + only_visible: Optional, defaults to true. + When set to true the set will only include visible packages, + when set to false it will also include masked packages. + It's currently only effective in in combination with the porttree + repository. + + + + + + + Multi Set Configuration + + In multi set configurations this class supports the following options: + + categories: Optional, defaults to all categories. + If set it must be a space separated list of existing ebuild categories for + which package sets should be created. + + repository: See previous section. + only_visible: See previous section. + name_pattern: Optional, defaults to + $category/*. This describes the naming pattern + to be used for creating the sets. It must contain either + $category or ${category}, which + will be replaced by the category name. + + + + portage.sets.dbapi.EverythingSet + + + Single Set Configuration + + This class does not support any options. + + -- 2.26.2