aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2007-10-23 14:31:13 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2007-10-23 14:31:13 +0000
commit03b22264c722db057605f48d967353b74326d0bc (patch)
treeab3f8e799313b66f2fac94e4d203f27169d0e1c5
parent767e07789a2794d67f3671dd22adcb898c48eea3 (diff)
downloadpaludis-03b22264c722db057605f48d967353b74326d0bc.tar.gz
paludis-03b22264c722db057605f48d967353b74326d0bc.tar.xz
Sets
-rw-r--r--doc/configuration/Makefile.am17
-rw-r--r--doc/configuration/sets.html.part.in55
2 files changed, 70 insertions, 2 deletions
diff --git a/doc/configuration/Makefile.am b/doc/configuration/Makefile.am
index 64ed363..167c967 100644
--- a/doc/configuration/Makefile.am
+++ b/doc/configuration/Makefile.am
@@ -29,6 +29,8 @@ CLEANFILES = *~ gmon.out *.gcov *.gcno *.gcda \
mirrors.html.part \
bashrc.html \
bashrc.html.part \
+ sets.html \
+ sets.html.part \
configfiles.html \
specs.html
@@ -51,7 +53,8 @@ EXTRA_DIST = \
use.html.part.in \
paludisenvironmentonly.html.part \
configfiles.html.part \
- specs.html.part
+ specs.html.part \
+ sets.html.part.in
paludisconfigurationhtmldir = $(htmldir)/configuration
@@ -70,7 +73,8 @@ paludisconfigurationhtml_DATA = \
licenses.html \
use.html \
configfiles.html \
- specs.html
+ specs.html \
+ sets.html
index.html : header.html.part $(srcdir)/index.html.part footer.html.part
cat header.html.part $(srcdir)/index.html.part footer.html.part > $@
@@ -168,6 +172,12 @@ bashrc.html.part : $(srcdir)/bashrc.html.part.in $(srcdir)/paludisenvironmentonl
-e 's,###PALUDISENVIRONMENTONLY###,,g' \
< $(srcdir)/bashrc.html.part.in > bashrc.html.part
+sets.html.part : $(srcdir)/sets.html.part.in $(srcdir)/paludisenvironmentonly.html.part
+ sed \
+ -e '/###PALUDISENVIRONMENTONLY###/r $(srcdir)/paludisenvironmentonly.html.part' \
+ -e 's,###PALUDISENVIRONMENTONLY###,,g' \
+ < $(srcdir)/sets.html.part.in > sets.html.part
+
licenses.html.part : $(srcdir)/licenses.html.part.in $(srcdir)/paludisenvironmentonly.html.part
sed \
-e '/###PALUDISENVIRONMENTONLY###/r $(srcdir)/paludisenvironmentonly.html.part' \
@@ -201,6 +211,9 @@ mirrors.html : header.html.part mirrors.html.part footer.html.part
bashrc.html : header.html.part bashrc.html.part footer.html.part
cat header.html.part bashrc.html.part footer.html.part > $@
+sets.html : header.html.part sets.html.part footer.html.part
+ cat header.html.part sets.html.part footer.html.part > $@
+
licenses.html : header.html.part licenses.html.part footer.html.part
cat header.html.part licenses.html.part footer.html.part > $@
diff --git a/doc/configuration/sets.html.part.in b/doc/configuration/sets.html.part.in
new file mode 100644
index 0000000..26dc7fc
--- /dev/null
+++ b/doc/configuration/sets.html.part.in
@@ -0,0 +1,55 @@
+<!-- vim: set tw=120 ft=html sw=4 sts=4 et : -->
+
+<h1>Sets</h1>
+
+<p>A set is a collection of package dependency specifications.</p>
+
+<h2>Built-in Sets</h2>
+
+<p>The following sets are always available:</p>
+
+<dl>
+ <dt>system</dt>
+ <dd>Defined by repositories, system consists of core packages that make up a basic system.</dd>
+
+ <dt>world</dt>
+ <dd>Consists of the system set, plus all packages that have been installed as targets (as opposed to merely pulled
+ in as dependencies of a target).</dd>
+
+ <dt>everything</dt>
+ <dd>All installed packages.</dd>
+
+ <dt>security</dt>
+ <dd>The set of upgrades which must be performed to resolve security holes.</dd>
+
+ <dt>insecurity</dt>
+ <dd>The set of insecure packages (mostly for internal use).</dd>
+
+ <dt>ununused</dt>
+ <dd>Any packages that, although not part of system or world, should none-the-less not be considered unused (again,
+ mostly for internal use).</dd>
+</dl>
+
+<h2>User Defined Sets</h2>
+
+###PALUDISENVIRONMENTONLY###
+
+<p>When using the Paludis environment, the user can create their own sets. A set named <code>foo</code> is defined in
+the file <code>sets/foo.conf</code>, which is a standard configuration file and which may be a bash file.</p>
+
+<div class="note">
+ <p>Overriding built-in sets in this manner is not recommended. Strange things will happen.</p>
+</div>
+
+<p>Each line in a user set file consists of an operator, followed by whitespace, followed by a package dependency
+specification. Permitted operators are:</p>
+
+<dl>
+ <dt><code>*</code></dt>
+ <dd>Indicates that the specification is part of the set.</dd>
+
+ <dt><code>?</code></dt>
+ <dd>Indicates that the specification is part of the set if and only if a package whose name is equal to the name
+ part of the specification is installed.</dd>
+</dl>
+