From d20112c869f3a3994e95e4f661863f6267dddc53 Mon Sep 17 00:00:00 2001 From: Zac Medico Date: Sun, 7 Jun 2009 06:50:54 +0000 Subject: Bug #272063 - Use elements inside elements. svn path=/main/trunk/; revision=13630 --- doc/config/sets.docbook | 172 +++++++++++---------- doc/dependency_resolution/decision_making.docbook | 8 +- doc/dependency_resolution/package_modeling.docbook | 26 ++-- doc/dependency_resolution/task_scheduling.docbook | 14 +- doc/package/ebuild/phases.docbook | 40 +++-- 5 files changed, 129 insertions(+), 131 deletions(-) diff --git a/doc/config/sets.docbook b/doc/config/sets.docbook index dc26b1a0..3371c175 100644 --- a/doc/config/sets.docbook +++ b/doc/config/sets.docbook @@ -50,19 +50,21 @@ handler might be changed in future versions.. That option defines which handler class should be used to create the set. Other universal options available for single sets are: + - name (which is usually not needed as the name + name (which is usually not needed as the name of the set is generated from the section name if name - is missing) - world-candidate, which determines if - given package should be added to the world set - extend to include the contents of other package sets + is missing) + world-candidate, which determines if + given package should be added to the world set + extend to include the contents of other package sets - remove to remove the contents of other package sets + remove to remove the contents of other package sets - intersect to only include packages that are also - included in one or more other package sets + intersect to only include packages that are also + included in one or more other package sets + Some handler classes might require additional options for their configuration, these will be covered later in this chapter. @@ -168,36 +170,36 @@ 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. - greedy: Optional, defaults to false. + filename: Required. Specifies the path to the file + that should be used for the package set. + greedy: Optional, defaults to false. Determines if atoms in the package should include all installed slots (when set to true) or if no slot expansion is wanted (when set to false). This option only affects packages that have multiple - slots available (e.g. sys-kernel/gentoo-sources). + slots available (e.g. sys-kernel/gentoo-sources). - Multi Set Configuration In a multi set configuration this class supports the following options: + - directory: Optional, defaults to + 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. + that location a separate package set is created. - name_pattern: Optional, defaults to + name_pattern: Optional, defaults to $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). + will be replaced by the filename (without any directory components). - @@ -216,35 +218,35 @@ Single Set Configuration In a single set configuration this class supports the following options: + - filename: See - StaticFileSet + filename: See + StaticFileSet - Multi Set Configuration In a multi set configuration this class supports the following options: + - directory: Optional, defaults to + 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. + No other files in that directory will be used. - name_pattern: Optional, defaults to + name_pattern: Optional, defaults to 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). + use or mask). - @@ -296,18 +298,18 @@ Single Set Configuration In single set configurations this class supports the following options: + - use_emerge_resolver: Optional, defaults to + use_emerge_resolver: Optional, defaults to false. This option determines which resolver strategy should be used for the set atoms. When set to true, it will use the default emerge algorithm and use the highest visible version that matches the GLSA. If set to false it will use the default glsa-check algorithm and use the lowest version that matches the GLSA and is - higher than the currently installed version (least change policy). + higher than the currently installed version (least change policy). - @@ -323,8 +325,8 @@ In single set configurations this class supports the following options: - use_emerge_resolver: See - SecuritySet + use_emerge_resolver: See + SecuritySet @@ -344,12 +346,12 @@ Single Set Configuration In single set configurations this class supports the following options: + - use_emerge_resolver: See - SecuritySet + use_emerge_resolver: See + SecuritySet - @@ -365,12 +367,12 @@ Single Set Configuration In single set configurations this class supports the following options: + use_emerge_resolver: See SecuritySet - @@ -386,14 +388,14 @@ Single Set Configuration In single set configurations this class supports the following options: + - command: Required. Specifies the command + command: Required. Specifies the command that should be executed to generate the package set. It should output a newline separated list of simple and/or versioned atoms - on stdout. + on stdout. - @@ -408,18 +410,18 @@ Single Set Configuration In single set configurations this class supports the following options: + - age: Optional, defaults to 7. Specifies - the number of days passed since installation to use as cut-off point. + age: Optional, defaults to 7. Specifies + the number of days passed since installation to use as cut-off point. - mode: Optional, defaults to "older". Must + mode: Optional, defaults to "older". Must be either "older" or "newer" to select packages installed either before resp. after the cut-off-date given by age. E.g. the defaults will select all installed packages that have been - installed more than one week ago. + installed more than one week ago. - @@ -433,39 +435,39 @@ 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. + category: Required. The name of an existing ebuild + category which should be used to create the package set. - only_visible: Optional, defaults to true. + 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 combination with the porttree + It's currently only effective 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. + 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. + which package sets should be created. - repository: See previous section. - only_visible: See previous section. - name_pattern: Optional, defaults to + 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. + will be replaced by the category name. - @@ -491,12 +493,12 @@ Package set which contains all packages that own one or more files. This class supports the following options: + - files: Required. A list of file paths - that should be used to create the package set. + files: Required. A list of file paths + that should be used to create the package set. - portage.sets.dbapi.VariableSet @@ -504,23 +506,23 @@ Package set which contains all packages that match specified values of specified variable. This class supports the following options: + - variable: The name of - the specified variable whose values are checked. + variable: The name of + the specified variable whose values are checked. - includes: A list of + includes: A list of values that must be contained within the specified - variable. + variable. - excludes: A list of + excludes: A list of values that must not be contained within the specified - variable. + variable. - metadata-source: Optional, defaults to + metadata-source: Optional, defaults to "vartree". Specifies the repository to use for getting the metadata - to check. + to check. - portage.sets.dbapi.UnavailableSet @@ -529,12 +531,12 @@ packages for which there are no visible ebuilds corresponding to the same $CATEGORY/$PN:$SLOT. This class supports the following options: + - metadata-source: Optional, defaults to + metadata-source: Optional, defaults to "porttree". Specifies the repository to use for getting the metadata - to check. + to check. - portage.sets.dbapi.DowngradeSet @@ -556,12 +558,12 @@ Single Set Configuration This class supports the following option: + - debug: Generate extra output useful to figure out why - certain packages are included in the set, as it's not always obvious. + debug: Generate extra output useful to figure out why + certain packages are included in the set, as it's not always obvious. - @@ -576,20 +578,20 @@ The default sets are: + - system: uses PackagesSystemSet - world: uses WorldSet - security: uses NewAffectedSet with default options - installed: uses EverythingSet - preserved-rebuild: uses PreservedLibraryConsumerSet - live-rebuild: uses VariableSet - module-rebuild: uses OwnerSet - downgrade: uses DowngradeSet - unavailable: uses UnavailableSet + system: uses PackagesSystemSet + world: uses WorldSet + security: uses NewAffectedSet with default options + installed: uses EverythingSet + preserved-rebuild: uses PreservedLibraryConsumerSet + live-rebuild: uses VariableSet + module-rebuild: uses OwnerSet + downgrade: uses DowngradeSet + unavailable: uses UnavailableSet - Additionally the default configuration includes a multi set section based on + Additionally the default configuration includes a multi set section based on the StaticFileSet defaults that creates a set for each - file in /etc/portage/sets for convenience. - + file in /etc/portage/sets for convenience. diff --git a/doc/dependency_resolution/decision_making.docbook b/doc/dependency_resolution/decision_making.docbook index 5bcf8438..ffb1a4ab 100644 --- a/doc/dependency_resolution/decision_making.docbook +++ b/doc/dependency_resolution/decision_making.docbook @@ -18,18 +18,18 @@ to satisfy constraints and minimize cost. The following package states influence the cost calculation for a given combination: + - installed + installed - selected (for installation) + selected (for installation) - not selected (for installation) + not selected (for installation) - In cost calculations, virtual packages by themselves are considered to cost nothing since they do not directly install anything. diff --git a/doc/dependency_resolution/package_modeling.docbook b/doc/dependency_resolution/package_modeling.docbook index 37cdb600..beada903 100644 --- a/doc/dependency_resolution/package_modeling.docbook +++ b/doc/dependency_resolution/package_modeling.docbook @@ -8,41 +8,41 @@ Dependency resolution involves satisfaction of many constraints: + - Persistent configuration parameters, like those that come from - make.profile, make.conf, and the /etc/portage directory. + Persistent configuration parameters, like those that come from + make.profile, make.conf, and the /etc/portage directory. - Current command parameters, which may include options, atoms, or sets. + Current command parameters, which may include options, atoms, or sets. - - Package Dependencies + + Package Dependencies - Package Dependencies Common types of package dependencies: + - Files required for building or installing. Downloads may - be necessary to satisfy these. + Files required for building or installing. Downloads may + be necessary to satisfy these. - Other packages required to be installed for - buildtime or runtime. + Other packages required to be installed for + buildtime or runtime. - Blockers that prevent conflicting packages from being installed - simultaneously. + Blockers that prevent conflicting packages from being installed + simultaneously. - diff --git a/doc/dependency_resolution/task_scheduling.docbook b/doc/dependency_resolution/task_scheduling.docbook index c8e3608d..8180e56d 100644 --- a/doc/dependency_resolution/task_scheduling.docbook +++ b/doc/dependency_resolution/task_scheduling.docbook @@ -24,28 +24,28 @@ rather than replaced. The following constraints protect inappropriate packages from being chosen for automatic uninstallation: + - Installed packages that have been pulled into the current dependency + Installed packages that have been pulled into the current dependency graph will not be uninstalled. Due to dependency neglection and special properties of packages in the "system" set, other checks may be necessary in order - to protect inappropriate packages from being uninstalled. + to protect inappropriate packages from being uninstalled. - An installed package that is matched by a dependency atom from the + An installed package that is matched by a dependency atom from the "system" set will not be uninstalled in advance since it might not - be safe. Such a package will only be uninstalled through replacement. + be safe. Such a package will only be uninstalled through replacement. - An installed package that is matched by a dependency atom from the + An installed package that is matched by a dependency atom from the "world" set will not be uninstalled if the dependency graph does not contain a replacement package that is matched by the same dependency - atom. + atom. - In order to ensure that package files remain installed in a usable state whenever possible, uninstallation operations are not executed diff --git a/doc/package/ebuild/phases.docbook b/doc/package/ebuild/phases.docbook index 2cb1b444..f3e8359e 100644 --- a/doc/package/ebuild/phases.docbook +++ b/doc/package/ebuild/phases.docbook @@ -10,36 +10,36 @@ The function names for the ebuild phases, listed in order of execution: + - pkg_setup + pkg_setup - src_unpack + src_unpack - src_compile + src_compile - src_test + src_test - src_install + src_install - pkg_preinst + pkg_preinst - pkg_postinst + pkg_postinst - pkg_prerm + pkg_prerm - pkg_postrm + pkg_postrm -
Interaction with previous installed version @@ -48,22 +48,20 @@
Upgrade/downgrade order used by versions less than 2.1.5 (deprecated) - - pkg_preinst + pkg_preinst - pkg_postinst + pkg_postinst - pkg_prerm + pkg_prerm - pkg_postrm + pkg_postrm -
Upgrade/downgrade order starting with version 2.1.5 @@ -71,22 +69,20 @@ The new order for upgrades and downgrades is identical to the order used for reinstall operations: - - pkg_preinst + pkg_preinst - pkg_prerm + pkg_prerm - pkg_postrm + pkg_postrm - pkg_postinst + pkg_postinst - Now that pkg_postinst is called after all other phases, it's not possible to call has_version in pkg_postinst to detect whether the current install -- cgit v1.2.3-65-gdbad