diff options
| -rw-r--r-- | doc/configuration/Makefile.am | 19 | ||||
| -rw-r--r-- | doc/configuration/repositories.html.part.in | 59 |
2 files changed, 75 insertions, 3 deletions
diff --git a/doc/configuration/Makefile.am b/doc/configuration/Makefile.am index 167c967..28f4a00 100644 --- a/doc/configuration/Makefile.am +++ b/doc/configuration/Makefile.am @@ -32,7 +32,9 @@ CLEANFILES = *~ gmon.out *.gcov *.gcno *.gcda \ sets.html \ sets.html.part \ configfiles.html \ - specs.html + specs.html \ + repositories.html.part \ + repositories.html.part.in MAINTAINERCLEANFILES = Makefile.in @@ -54,7 +56,8 @@ EXTRA_DIST = \ paludisenvironmentonly.html.part \ configfiles.html.part \ specs.html.part \ - sets.html.part.in + sets.html.part.in \ + repositories.html.part.in paludisconfigurationhtmldir = $(htmldir)/configuration @@ -74,7 +77,8 @@ paludisconfigurationhtml_DATA = \ use.html \ configfiles.html \ specs.html \ - sets.html + sets.html \ + repositories.html index.html : header.html.part $(srcdir)/index.html.part footer.html.part cat header.html.part $(srcdir)/index.html.part footer.html.part > $@ @@ -154,6 +158,12 @@ keywords.html.part : $(srcdir)/keywords.html.part.in $(srcdir)/paludisenvironmen -e 's,###PALUDISENVIRONMENTONLY###,,g' \ < $(srcdir)/keywords.html.part.in > keywords.html.part +repositories.html.part : $(srcdir)/repositories.html.part.in $(srcdir)/paludisenvironmentonly.html.part + sed \ + -e '/###PALUDISENVIRONMENTONLY###/r $(srcdir)/paludisenvironmentonly.html.part' \ + -e 's,###PALUDISENVIRONMENTONLY###,,g' \ + < $(srcdir)/repositories.html.part.in > repositories.html.part + packagemask.html.part : $(srcdir)/packagemask.html.part.in $(srcdir)/paludisenvironmentonly.html.part sed \ -e '/###PALUDISENVIRONMENTONLY###/r $(srcdir)/paludisenvironmentonly.html.part' \ @@ -202,6 +212,9 @@ environment.html : header.html.part environment.html.part footer.html.part keywords.html : header.html.part keywords.html.part footer.html.part cat header.html.part keywords.html.part footer.html.part > $@ +repositories.html : header.html.part repositories.html.part footer.html.part + cat header.html.part repositories.html.part footer.html.part > $@ + packagemask.html : header.html.part packagemask.html.part footer.html.part cat header.html.part packagemask.html.part footer.html.part > $@ diff --git a/doc/configuration/repositories.html.part.in b/doc/configuration/repositories.html.part.in new file mode 100644 index 0000000..c694dd9 --- /dev/null +++ b/doc/configuration/repositories.html.part.in @@ -0,0 +1,59 @@ +<!-- vim: set tw=120 ft=html sw=4 sts=4 et : --> + +<h1>Repositories</h1> + +###PALUDISENVIRONMENTONLY### + +<p>Each file in <code>repositories/</code> named <code>*.conf</code> defines a repository. A repository configuration +file is a standard key=value config file, and it may be in bash format. The <code>repository_defaults.conf</code> file +(which does <em>not</em> live in the <code>repositories</code> subdirectory), if it exists, is treated as if it were +prepended to each individual file.</p> + +<div class="note"> + <p>The filenames used for repository configuration files have no effect upon the names of the repositories. Whilst + you <em>could</em> use the name <code>giant-space-monkey.conf</code> for the repository named <code>gentoo</code>, + for user sanity reasons it is best to use the repository name as the filename.</p> +</div> + +<h2>Predefined Keys</h2> + +<p>The following keys are predefined. They should not be modified.</p> + +<dl> + <dt>root</dt> + <dd>The filesystem root. Relevant if <code>specpath.conf</code> is in use. Using this variable can create a + configuration system that works both inside and outside of a chroot (e.g. <code>location = + ${root}/var/db/paludis/repositories/paludis-overlay</code>).</dd> +</dl> + +<h2>General Keys</h2> + +<p>The following keys are meaningful for all repository formats.</p> + +<dl> + <dt>format</dt> + <dd>Determines which repository class Paludis uses to create the repository. Example formats are + <code>ebuild</code>, <code>vdb</code> and <code>installed_unpackaged</code>. Mandatory.</dd> + + <dt>importance</dt> + <dd>Must be an integer. Used by Paludis to determine from which repository a package should be selected, all other + things being equal (a higher importance is preferred over a lower importance). By default, <code>0</code>, except + if the <code>master_repository</code> key is set, in which case it is <code>10</code> instead.</dd> +</dl> + +<p>For format-specific keys, see the documentation for that format.</p> + +<h2>Predefined Repositories</h2> + +<p>If using a distribution that supports old-style virtuals, two repositories are magically defined:</p> + +<dl> + <dt><code>virtuals</code></dt> + <dd>A special repository that contains special package entries for old style virtuals, mapping them to their + providers.</dd> + + <dt><code>installed-virtuals</code></dt> + <dd>A special repository that contains special package entries for installed old style virtuals (provided + packages).</dd> +</dl> + |