| Home | Trees | Indices | Help |
|
|---|
|
|
object --+
|
recipe.Recipe --+
|
_BaseGroupRecipe --+
|
GroupRecipe
r.GroupRecipe() - Provides the recipe interface
for creating a group.
The r.GroupRecipe class provides the interface for
creation of groups in a Conary recipe. A group refers to a collection
of troves; the troves may be related in purpose to provide a useful
functionality, such as a group of media-related troves to provide
encoding, decoding, and playback facilities for various media, for
example. Groups are not required to consist of troves with related
functionality however, and may contain a collection of any arbitrary
troves.
Most r.GroupRecipe user commands accept a
groupName parameter. This parameter specifies the group a
particular command applies to. For example, r.add('foo',
groupName='group-bar') attempts to add the trove foo to
the group group-bar.
Several parameters may be set at the time of group creation.
Although these parameters are typically passed to
r.createGroup() for the base group, they should be set as
variables in the recipe class.
Note: Setting these parameters affects not only the value for the
base group, but also the default value for all newly created groups.
For example, if autoResolve is set to True in the
base group, all other groups created will have autoResolve set to
True by default. imageGroup is an exception to this
rule; it will not propogate to sub groups.
The following parameters are accepted by r.GroupRecipe
with default values indicated in parentheses when applicable:
depCheck : (False) If set to True, Conary will
check for dependency closure in this group, and raise an error if
closure is not found.
autoResolve : (False) If set to True, Conary
will include any extra troves needed to make this group dependency
complete.
checkOnlyByDefaultDeps : (True) Conary only checks the
dependencies of troves that are installed by default, referenced in the
group. If set to False, Conary will also check the
dependencies of byDefault False troves. Doing
this, however, will prevent groups with
autoResolve=True from changing the
byDefault status of required troves.
checkPathConflicts : (True) Conary checks for path conflicts
in each group by default to ensure that the group can be installed
without path conflicts. Setting this parameter to False
will disable the check.
|
|||
|
Inherited from |
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
Inherited from Inherited from Inherited from Inherited from Inherited from |
|||
|
|||
|
Inherited from |
|||
|
|||
Flags = Flags: {}
|
|||
internalAbstractBaseClass = 1
|
|||
_recipeType = 3
|
|||
depCheck = False
|
|||
autoResolve = None
|
|||
imageGroup = True
|
|||
checkOnlyByDefaultDeps = True
|
|||
checkPathConflicts = True
|
|||
requireLatest = True
|
|||
|
Inherited from Inherited from |
|||
|
|||
|
Inherited from |
|||
|
|||
|
r.Requires() - Defines a runtime requirement for
group
SYNOPSISr.Requires(requirement, [groupName])
DESCRIPTIONTher.Requires command causes a group to have a runtime
requirement of the trove requirement.
PARAMETERSThe requirement : (None) Specifies the group runtime requirement groupName : (None) The name of the group to affectEXAMPLES
r.Requires to specify that the trove
tmpwatch must be installed in order for the group to be
installed.
|
r.add() - Adds a trove to a group
SYNOPSISr.add(name, [versionStr,] [flavor,]
[source,] [byDefault,] [ref,]
[requireLatest,] [components,] [groupName,]
[searchPath])
DESCRIPTIONTher.add() command is used to add a trove to a
group.
PARAMETERSThe byDefault : (None, or value of createGroup) Specifies whether to include a trove by default. Defaults to the byDefault setting as defined with createGroup. components : (None) Specify a set of trove components to
include. Only relevant when adding packages. Specified as a list, such
as flavor : (None) A flavor limiter such as that passed to repquery which determines the trove returned. groupName : (None) The group to add trove to. name : (None) Specifies the name of trove to add- This parameter is required. source : (None) Specifies the source from which this trove originates for programs which read group recipes. This parameter's explicit use is generally unnecessary. versionStr : (None) A version specifier like that passed to repquery which determines the trove returned. requireLatest : Raise an error if add resolves to an older trove than the latest on branch. This can occur when a flavor of a trove exists that is not the latest version. use: (True) A Use flag, or boolean, or a tuple of Use flags, and/or boolean values which determine whether the trove(s) are added to the group searchPath : (None) Set a specific searchPath to search for this particular trove. This overrides the ref flag. See setSearchPath for a description of how the searchPath works.EXAMPLES
gzip:runtime trove to the current group.
|
r.add() - Adds a trove to a group
SYNOPSISr.add(name, [versionStr,] [flavor,]
[source,] [byDefault,] [ref,]
[requireLatest,] [components,] [groupName,]
[searchPath])
DESCRIPTIONTher.add() command is used to add a trove to a
group.
PARAMETERSThe byDefault : (None, or value of createGroup) Specifies whether to include a trove by default. Defaults to the byDefault setting as defined with createGroup. components : (None) Specify a set of trove components to
include. Only relevant when adding packages. Specified as a list, such
as flavor : (None) A flavor limiter such as that passed to repquery which determines the trove returned. groupName : (None) The group to add trove to. name : (None) Specifies the name of trove to add- This parameter is required. source : (None) Specifies the source from which this trove originates for programs which read group recipes. This parameter's explicit use is generally unnecessary. versionStr : (None) A version specifier like that passed to repquery which determines the trove returned. requireLatest : Raise an error if add resolves to an older trove than the latest on branch. This can occur when a flavor of a trove exists that is not the latest version. use: (True) A Use flag, or boolean, or a tuple of Use flags, and/or boolean values which determine whether the trove(s) are added to the group searchPath : (None) Set a specific searchPath to search for this particular trove. This overrides the ref flag. See setSearchPath for a description of how the searchPath works.EXAMPLES
gzip:runtime trove to the current group.
|
r.remove() - Removes a trove
SYNOPSISr.remove(name, [flavor,] [groupName,]
[versionStr], [allowNoMatch])
DESCRIPTIONThe Note: If the trove is not included explicitly, such as by
Troves present due to an included subgroup can be removed from a supergroup. For example, the group group-os is a top level group, and includes group-dist, which in turn, includes package foo. Usingr.remove('foo', groupName='group-os') prevents
installation of package foo during the installation of the group
group-os.
PARAMETERSThe flavor : (None) A flavor limiter such as that passed to repquery which determines the trove returned. groupName : (None) The name of the group to remove trove from name : (None) The name of the trove to be removed. This parameter is required. versionStr : (None) A version specifier like that passed to repquery which determines the trove returned. allowNoMatch : (False) Silences the warning output if this remove did not match anything.EXAMPLES
kernel:configs from the current group
for the flavor kernel.smp.
|
r.removeComponents() - Define components which
should not be installed by default
SYNOPSISr.removeComponents(componentList,
[groupName])
DESCRIPTIONTher.removeComponents command specifies components
which should not be installed by default when installing the group.
PARAMETERSThe componentList : (None) A list of components which should not be installed by default when the group is installed groupName : (None) The name of the group to affectEXAMPLES
r.RemoveComponents to specify that the
:devel and :devellib components should not be
installed by default.
|
r.moveComponents() - Add components to one group,
removing them from the other in the process.
SYNOPSISr.moveComponents(componentList, fromGroup,
toGroup, [byDefault])
DESCRIPTIONTher.moveComponents removes components from the
fromGroup, and adds those components to the toGroup.
PARAMETERSThe componentList : A list of components which should be moved from fromGroup to toGroup. Example: ['devel', 'devellib'] fromGroup : The name of the group to move the components from toGroup : The name of the group to move the components to byDefault : (None) When specified, this ensures that all the components that are added have the byDefault value specified (either True or False). If not specified, the components get the byDefault value they had in the fromGroup.EXAMPLES
r.moveComponents to specify that those
:devel and :devellib components that exist in
group-core should be removed from group-core and added to
group-devel.
|
r.copyComponents() - Add components to one group
by copying them from the components in another group.
SYNOPSISr.copyComponents(componentList, fromGroup,
toGroup, [byDefault])
DESCRIPTIONTher.copyComponents copies the listed component types
from the fromGroup to the toGroup.
PARAMETERSThe componentList : A list of components which should be copied from fromGroup to toGroup. Example: ['devel', 'devellib'] fromGroup : The name of the group to copy the components from toGroup : The name of the group to copy the components to byDefault : (None) When specified, this ensures that all the components that are added have the byDefault value specified (either True or False). If not specified, the components get the byDefault value they had in the fromGroup.EXAMPLES
r.copyComponents to specify that those
:devel and :devellib components that exist in
group-core should be added to group-devel.
|
r.setSearchPath() - Specify the searchPath to
search for troves
SYNOPSISr.setSearchPath(pathspec)
DESCRIPTIONThe SearchPaths can currently consist of two types of items: labels and troves. Labels must be of the form <host>@<namespace>:<tag>, while troves are of the form <name>[=version][[flavor]]. For example, a label might be myproject.rpath.org@rpl:1, while a trove may be specified as:group-dist, or group-dist=1.0, or group-dist=:1[!xen], or group-dist=/myproject.rpath.org@rpl:1/1.0-1-1. More formats for troves are allowed as well, see troveSpec documentation for the full list of allowable specifications for troves. setSearchPath will also determine how dependency resolution is done when using autoResolve. Dependency resolution will use the same search path specified here. AddResolutionSource (deprecated) overrides setSearchPath's control of dependency resolution. If you use addResolutionSource, setSearchPath will only control the search path for adding troves.PARAMETERSThe EXAMPLES
r.setSearchPath to specify troves are to be sought
in the label myproject.rpath.org@rpl:1 first, and then fallback to
searching the group group-dist=conary.rpath.com@rpl:1.
|
r.setByDefault() - Set troves to be added to group
by default
SYNOPSISr.setByDefault(byDefault,
[groupName])
DESCRIPTIONTher.setByDefault command specifies whether troves are
added to the group by default.
PARAMETERSThe byDefault : (Current group setting) Whether to add troves to
this group byDefault EXAMPLES
group-ftools by default.
|
r.addAll() - Add all troves directly contained in
a given reference to groupName
SYNOPSISr.addAll(name, [versionStr], [flavor,]
[ref,] [requireLatest,] [recurse,]
[groupName,] [use,] [searchPath,]
[flatten,] [copyScripts,]
[copyCompatibilityClass])
DESCRIPTIONThe For example, if the cooked group-foo contains references to
the troves r.add('foo1', <version>) r.add('foo2',
<version>).
PARAMETERSThe groupName : (None) The group to add trove to recurse : (True) If True, and the trove you specify with
addAll contains groups, new groups will be created in the recipe
that match those contained groups, and the Note: If the subgroups already exist in the group, those preexisting groups will be used. Otherwise, the default settings will be used when creating any new groups. searchPath: (None) searchPath to search in for this trove.
See flatten: (False) If True, acts like recurse=True but removes
any intermediate groups. So if group-os includes group-dist, which
includes group-core, which includes openssh, you can use
use: (True) A Use flag, or boolean, or a tuple of Use flags, and/or boolean values which determine whether the trove(s) are added to the group copyScripts: (False) When True the scripts attached to the group being copied are attached to this group. copyCompatibilityClass: (False) When True the compatibility class for this group is set based on the class of the group being copied. ref: (None) (deprecated) Trove reference to search in for
this trove. See EXAMPLES
r.addAll to add the troves referenced by
group-core to the recipe for version string
'conary.rpath.com@rpl:1'.
|
r.removeItemsAlsoInNewGroup() - removes troves in
the group specified that are also in the current group.
SYNOPSISr.removeItemsAlsoInNewGroup(name,
[groupName,])
DESCRIPTIONThe All troves in the first group are removed from the second group. This can be compared to the "difference" operation in when using sets. For example, if the cooked group-foo contains references to the trovesfoo1=<version>[flavor], and
foo2=<version>[flavor], and the current group
contains references to the troves
foo1=<version>[flavor], and
foo3=<version>[flavor], r.removeItesAlsoInNewGroup
would remove foo1 from the current group.
PARAMETERSThe name : (Required) The group that contains the trove to remove groupName : (None) The group to remove troves from (default current) use: (True) A Use flag, or boolean, or a tuple of Use flags, and/or boolean values which determine whether the trove(s) are removed from the groupEXAMPLES
|
r.removeItemsAlsoInGroup() - removes troves in the
group specified that are also in the current group.
SYNOPSISr.removeItemsAlsoInGroup(name, [versionStr],
[flavor,] [groupName,] [searchPath,])
DESCRIPTIONThe All troves in the first group are removed from the second group. This can be compared to the "difference" operation in when using sets. For example, if the cooked group-foo contains references to the trovesfoo1=<version>[flavor], and
foo2=<version>[flavor], and the current group
contains references to the troves
foo1=<version>[flavor], and
foo3=<version>[flavor], r.removeItesAlsoInNewGroup
would remove foo1 from the current group.
PARAMETERSThe name : (Required) The group that contains the troves to remove groupName : (None) The group to remove troves from (default current) use: (True) A Use flag, or boolean, or a tuple of Use flags, and/or boolean values which determine whether the trove(s) are removed from the group searchPath: (None) searchPath to search in for the group that contains the troves to remove. Seer.setSearchPath() for
more information.
EXAMPLES
|
r.addCopy() - Create a copy of name and add
that copy to groupName.
SYNOPSISr.addCopy(name, [flavor,] [groupName,]
[recurse,] [ref,] [requireLatest,]
[versionStr,] [copyScripts,]
[copyCompatibilityClass])
DESCRIPTIONThe For example, if the cooked group-foo contains references to
the troves r.createGroup('group-foo') r.add('foo1',
<version>, groupName='group-foo') r.add('foo2',
<version>, groupName='group-foo')
r.addNewGroup('group-foo').
PARAMETERSThe groupName : (None) The group to add the copy to. recurse : (True) If True, and the trove you specify with
addCopy contains groups, new groups will be created in the
recipe that match those contained groups, and the
Note: If the subgroups already exist in the group, those preexisting groups will be used. Otherwise, the default settings will be used when creating any new groups. copyScripts: (True) When True the scripts attached to the groups being copied are attached to the newly created groups. copyCompatibilityClass: (True) When True the compatibility class for the newly created groups are set to the compatibility classes from the groups being copied. ref: (None) (Deprecated) Trove reference to search in for
this trove. See requireLatest : Raise an error if addCopy resolves to an older trove than the latest on branch. This can occur when a flavor of a trove exists that is not the latest version. searchPath: (None) searchPath to search in for this trove.
See EXAMPLES
r.addCopy to create a new group called
group-core, copy all the troves from the old
group-core to the new group, and then add the new
group-core to the current group.
|
r.addNewGroup() - Adds one newly created group to
another newly created group
SYNOPSISr.addNewGroup(name, [byDefault,]
[groupName])
DESCRIPTIONTher.addNewGroup() command is used to add one newly
created group to another newly created group.
PARAMETERSThe name : (None) The name of group to add byDefault: (True) Whether to add this group by default. groupName : (Current group name) The name(s) of group(s) to add this trove to. use: (True) A Use flag, or boolean, or a tuple of Use flags, and/or boolean values which determine whether the trove(s) are added to the groupEXAMPLES
group-3d to the group
group-graphics.
|
r.setDefaultGroup() - Defines default group
SYNOPSISr.setDefaultGroup(groupName)
DESCRIPTIONTher.setDefaultGroup command specifies the current
group which all commands will apply to if no groupName is
specified as a parameter to a given command.
PARAMETERSThe EXAMPLES
group-consmod.
|
r.addResolveSource() - Specify alternate source
for dependency resolution
SYNOPSISr.addResolveSource(name, [versionStr],
[flavor], [ref])
DESCRIPTIONThe r.addResolveSource does not imply
autoResolve, since autoResolve is a per-group
option and addResolveSource is globally defined
PARAMETERSThe name : (None) The name of the reference to add versionStr : (None) A version specifier like that passed to flavor : (None) A flavor limiter such as that passed to repquery which determines the trove returned. ref : (None) Trove reference to search for this trove in. Seer.addReference for more information.
EXAMPLES
r.addResolveSource to specify dependency
resolution should be performed against the labelPath
foo.example.com@foo:devel
|
r.addReference - Adds a reference to a trove
SYNOPSISr.addReference(name, [flavor,] [ref,]
[versionStr])
DESCRIPTIONThe PARAMETERSThe flavor : (None) A flavor limiter such as that passed to repquery which determines the trove returned. name : (None) The name of the reference to add ref : (None) Trove reference to search for this trove in. See
EXAMPLES
r.addReference to Define coreRef as a
reference to the group-trove group-core for version string
'conary.rpath.com@rpl:1', and then uses an r.add
invocation to add tmpwatch using the coreRef
reference.
|
r.replace() - Replace troves
SYNOPSISr.replace(name, [groupName,] [newFlavor,]
[newVersionStr], [allowNoMatch],
[searchPath])
DESCRIPTIONThe r.replace() affects all
groups; this behavior is different from other group commands.
PARAMETERSThe name : (None) Specify name of the trove to replace groupName : (None) The name of the group to affect newFlavor : (None) The new flavor to add newVersionStr : (None) The new version to add ref : (None) The trove reference to search for the trove in allowNoMatch : (False) Silences the warning output if this replace did not match anything. searchPath : (None) Set a specific searchPath to search for this particular trove. This overrides the ref flag. See setSearchPath for a description of how the searchPath works.EXAMPLESr.replace('distro-release') Usesr.replace to remove all instances of the
distro-release trove, and replaces them with a new version
of distro-release.
|
r.setLabelPath() - Specify the labelPath to search
for troves
SYNOPSISr.setLabelPath(pathspec)
DESCRIPTIONTher.setLabelPath command specifies the labelPath used
to search for troves.
PARAMETERSThe EXAMPLES
r.setLabelPath to specify troves are to be sought
in the LabelPaths 'myproject.rpath.org@rpl:1' and
'conary.rpath.com@rpl:1'.
|
r.setCompatibilityClass() - Specify the
compatibility class for this trove.
SYNOPSISr.setCompatibilityClass(class)
DESCRIPTIONTher.setCompatibilityClass command specifies the
compatibility class for this trove. When a trove is updated from one
compatibility class to another, the rollback stack is invalidated
unless the newly-installed trove provides a postRollback script which
supports the old trove's compatibility class.
PARAMETERSThe |
r.startGroup() - Creates a new group, and sets it
as the default group.
SYNOPSISr.startGroup(name, [autoResolve,]
[byDefault,] [checkOnlyByDefaultDeps,]
[checkPathConflicts,] [depCheck,] [groupName,]
[imageGroup])
DESCRIPTIONTher.startGroup command starts a new group. This
command aggregates createNewGroup, addNewGroup and setDefaultGroup.
PARAMETERSThe name : (None) The name of the group to be created. Must start with 'group-'. autoResolve : (False) Whether to resolve dependencies for this group. byDefault : whether or not to add the newly created group
byDefault checkOnlyByDefaultDeps : (Current group setting) Whether to
include byDefault checkPathConflicts : (Current group setting) Whether to check path conflicts for this group. depCheck : (False) Whether to check for dependency closure for this group. groupName : (None) The name of the parent group to add the newly created group to. imageGroup : (False) Designate that this group is a image group. Image Group policies will be executed separately on this group.EXAMPLES
Creates the group
group-multiplay and specifies no
dependencies are resolved automatically for this group.
|
r.createGroup() - Creates a new group
SYNOPSISr.createGroup(groupName, [autoResolve,]
[byDefault,] [checkOnlyByDefaultDeps,]
[checkPathConflicts,] [depCheck,]
[imageGroup])
DESCRIPTIONTher.createGroup command creates a new group.
PARAMETERSThe autoResolve : (False) Whether to resolve dependencies for this group. byDefault : (Current group setting) Whether to add troves to
this group byDefault checkOnlyByDefaultDeps : (Current group setting) Whether to
include byDefault checkPathConflicts : (Current group setting) Whether to check path conflicts for this group. depCheck : (False) Whether to check for dependency closure for this group. groupName : (None) The name of the group to be created. Must start with 'group-'. imageGroup : (False) Designate that this group is a image group. Image Group policies will be executed separately on this group.EXAMPLES
Creates the group
group-multiplay and specifies no
dependencies are resolved automatically for this group.
|
| Home | Trees | Indices | Help |
|
|---|
| Generated by Epydoc 3.0beta1 on Thu Jul 10 11:46:05 2008 | http://epydoc.sourceforge.net |