aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2007-10-23 18:40:34 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2007-10-23 18:40:34 +0000
commit1b72b5715a0c40487d757c8bbf9690a8a253aa64 (patch)
treec26d1d02d35eb99fb8398d24e8371ab514fa09b5
parente8a00346952ad831a74bfe205e4ca6a500715f57 (diff)
downloadpaludis-1b72b5715a0c40487d757c8bbf9690a8a253aa64.tar.gz
paludis-1b72b5715a0c40487d757c8bbf9690a8a253aa64.tar.xz
VDB
-rw-r--r--doc/configuration/Makefile.am19
-rw-r--r--doc/configuration/vdb.html.part.in34
2 files changed, 50 insertions, 3 deletions
diff --git a/doc/configuration/Makefile.am b/doc/configuration/Makefile.am
index 0577843..7095351 100644
--- a/doc/configuration/Makefile.am
+++ b/doc/configuration/Makefile.am
@@ -36,7 +36,9 @@ CLEANFILES = *~ gmon.out *.gcov *.gcno *.gcda \
repositories.html \
repositories.html.part \
erepository.html \
- erepository.html.part
+ erepository.html.part \
+ vdb.html \
+ vdb.html.part
MAINTAINERCLEANFILES = Makefile.in
@@ -60,7 +62,8 @@ EXTRA_DIST = \
specs.html.part \
sets.html.part.in \
repositories.html.part.in \
- erepository.html.part.in
+ erepository.html.part.in \
+ vdb.html.part.in
paludisconfigurationhtmldir = $(htmldir)/configuration
@@ -82,7 +85,8 @@ paludisconfigurationhtml_DATA = \
specs.html \
sets.html \
repositories.html \
- erepository.html
+ erepository.html \
+ vdb.html
index.html : header.html.part $(srcdir)/index.html.part footer.html.part
cat header.html.part $(srcdir)/index.html.part footer.html.part > $@
@@ -156,6 +160,12 @@ erepository.html.part : $(srcdir)/erepository.html.part.in $(srcdir)/paludisenvi
-e 's,###PALUDISENVIRONMENTONLY###,,g' \
< $(srcdir)/erepository.html.part.in > erepository.html.part
+vdb.html.part : $(srcdir)/vdb.html.part.in $(srcdir)/paludisenvironmentonly.html.part
+ sed \
+ -e '/###PALUDISENVIRONMENTONLY###/r $(srcdir)/paludisenvironmentonly.html.part' \
+ -e 's,###PALUDISENVIRONMENTONLY###,,g' \
+ < $(srcdir)/vdb.html.part.in > vdb.html.part
+
environment.html.part : $(srcdir)/environment.html.part.in $(srcdir)/paludisenvironmentonly.html.part
sed \
-e '/###PALUDISENVIRONMENTONLY###/r $(srcdir)/paludisenvironmentonly.html.part' \
@@ -249,6 +259,9 @@ specpath.html : header.html.part specpath.html.part footer.html.part
erepository.html : header.html.part erepository.html.part footer.html.part
cat header.html.part erepository.html.part footer.html.part > $@
+vdb.html : header.html.part vdb.html.part footer.html.part
+ cat header.html.part vdb.html.part footer.html.part > $@
+
syncers.html : header.html.part syncers.html.part footer.html.part
cat header.html.part syncers.html.part footer.html.part > $@
diff --git a/doc/configuration/vdb.html.part.in b/doc/configuration/vdb.html.part.in
new file mode 100644
index 0000000..0b1cb72
--- /dev/null
+++ b/doc/configuration/vdb.html.part.in
@@ -0,0 +1,34 @@
+<!-- vim: set tw=120 ft=html sw=4 sts=4 et : -->
+
+<h1>vdb Options</h1>
+
+###PALUDISENVIRONMENTONLY###
+
+<p>As well as the general keys supported for all repositories, the following keys have meaning for vdb format
+repositories:</p>
+
+<dl>
+ <dt><code>location</code></dt>
+ <dd>The location of the repository. Mandatory. On Gentoo systems, this must be <code>${root}/var/db/pkg</code> to
+ aviod problems with broken ebuilds that illegally access the VDB.</dd>
+
+ <dt><code>world</code></dt>
+ <dd>The location of the world file. Optional.</dd>
+
+ <dt><code>provides_cache</code></dt>
+ <dd>The directory to use for reading and writing a cache of providers of old-style virtuals. See <a
+ href="../overview/gettingstarted.html">Getting Started</a> for notes. Optional, set to <code>/var/empty</code>
+ to disable.</dd>
+
+ <dt><code>names_cache</code></dt>
+ <dd>The directory in which to look for a names cache, and in which to generate a names cache. A names cache will
+ significantly speed up converting a <code>pkg</code> into a <code>cat/pkg</code>. See <a
+ href="../overview/gettingstarted.html">Getting Started</a> for notes. Optional, set to <code>/var/empty</code>
+ to disable.</dd>
+
+ <dt><code>builddir</code></dt>
+ <dd>The directory to use when 'building' a package for an uninstall (a temporary directory is needed for various
+ operations). Optional.</dd>
+</dl>
+
+