aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2010-05-14 21:36:41 +0100
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2010-05-14 21:36:45 +0100
commit043b9ec3e042e0f2b127402dccf101af8ddb70fd (patch)
tree1b81b023f7e6afc0fc96f8c9f1a729bea4edfdb9
parentf851762537b0d2597968b8fc205e9afef26602c3 (diff)
downloadpaludis-043b9ec3e042e0f2b127402dccf101af8ddb70fd.tar.gz
paludis-043b9ec3e042e0f2b127402dccf101af8ddb70fd.tar.xz
Document R^2
-rw-r--r--.gitignore1
-rw-r--r--doc/configuration/repositories/Makefile.am8
-rw-r--r--doc/configuration/repositories/index.html.part1
-rw-r--r--doc/configuration/repositories/repository.html.part35
-rw-r--r--doc/configuration/repositories/toplinks.html.part.in8
-rw-r--r--doc/configuration/repositories/unavailable.html.part4
6 files changed, 52 insertions, 5 deletions
diff --git a/.gitignore b/.gitignore
index de4d932..2e2f007 100644
--- a/.gitignore
+++ b/.gitignore
@@ -144,6 +144,7 @@ paludis-*.*.*.tar.bz2
/doc/configuration/repositories/index.html
/doc/configuration/repositories/installed_accounts.html
/doc/configuration/repositories/installed_unpackaged.html
+/doc/configuration/repositories/repository.html
/doc/configuration/repositories/toplinks.html.part
/doc/configuration/repositories/unavailable.html
/doc/configuration/repositories/unwritten.html
diff --git a/doc/configuration/repositories/Makefile.am b/doc/configuration/repositories/Makefile.am
index cf69e7b..7071187 100644
--- a/doc/configuration/repositories/Makefile.am
+++ b/doc/configuration/repositories/Makefile.am
@@ -12,6 +12,7 @@ CLEANFILES += \
exndbam.html \
installed_accounts.html \
installed_unpackaged.html \
+ repository.html \
unavailable.html \
unwritten.html \
vdb.html
@@ -24,6 +25,7 @@ EXTRA_DIST = \
exndbam.html.part \
installed_accounts.html.part \
installed_unpackaged.html.part \
+ repository.html \
unavailable.html.part \
unwritten.html.part \
vdb.html.part
@@ -37,13 +39,14 @@ paludisconfigurationrepositorieshtml_DATA = \
exndbam.html \
installed_accounts.html \
installed_unpackaged.html \
+ repository.html \
unavailable.html \
unwritten.html \
vdb.html
if HAVE_HTMLTIDY
-TESTS = $(paludisconfigurationhtml_DATA)
+TESTS = $(paludisconfigurationrepositorieshtml_DATA)
LOG_COMPILER_INTERP = $(top_srcdir)/doc/htmltidy.bash
endif
@@ -66,6 +69,9 @@ installed_accounts.html : header.html.part $(srcdir)/installed_accounts.html.par
installed_unpackaged.html : header.html.part $(srcdir)/installed_unpackaged.html.part footer.html.part
cat header.html.part $(srcdir)/installed_unpackaged.html.part footer.html.part > $@
+repository.html : header.html.part $(srcdir)/repository.html.part footer.html.part
+ cat header.html.part $(srcdir)/repository.html.part footer.html.part > $@
+
unavailable.html : header.html.part $(srcdir)/unavailable.html.part footer.html.part
cat header.html.part $(srcdir)/unavailable.html.part footer.html.part > $@
diff --git a/doc/configuration/repositories/index.html.part b/doc/configuration/repositories/index.html.part
index 3fa447d..238505e 100644
--- a/doc/configuration/repositories/index.html.part
+++ b/doc/configuration/repositories/index.html.part
@@ -83,6 +83,7 @@ old-style virtuals:</p>
<li><a href="exndbam.html">exndbam</a>, for tracking installed packages installed from an exheres.</li>
<li><a href="accounts.html">accounts</a> and <a href="installed_accounts.html">installed_accounts</a> format
repositories, for tracking user and group accounts.</li>
+ <li><a href="repository.html">repository</a>, for automatic repository configuration.</li>
<li><a href="unwritten.html">unwritten</a>, for packages that have yet to be written.</li>
</ul>
diff --git a/doc/configuration/repositories/repository.html.part b/doc/configuration/repositories/repository.html.part
new file mode 100644
index 0000000..a4ccffc
--- /dev/null
+++ b/doc/configuration/repositories/repository.html.part
@@ -0,0 +1,35 @@
+<!-- vim: set tw=120 ft=html sw=4 sts=4 et : -->
+
+<h1>repository Repository Format</h1>
+
+<p>The <code>repository</code> repository format is used to automatically create configuration files for new
+repositories whose information is published in <code>unavailable</code> format repositories, which can be installed
+using packages named like <code>repository/foo</code>. At present it is only supported on Exherbo.</p>
+
+<p>As well as the <a href="index.html">general keys supported for all repositories</a>, the following keys have meaning
+for <code>repository</code> format repositories:</p>
+
+<dl>
+ <dt><code>config_template</code></dt>
+ <dd>The template file to use when creating configuration files. Mandatory. Most users will want to set this to
+ <code>/etc/paludis/repository.template</code>, which will then need to be created as described below.</dd>
+
+ <dt><code>config_filename</code></dt>
+ <dd>The filename to use when creating configuration files. Most users will want to set this to
+ <code>/etc/paludis/repositories/%{repository_template_name}.conf</code> (note the <code>%</code>, which is not
+ a <code>$</code>).</dd>
+</dl>
+
+<h2>Repository Template</h2>
+
+<p>A typical <code>/etc/paludis/repository.template</code> will look like:</p>
+
+<pre>
+format = %{repository_template_format}
+location = /var/db/paludis/repositories/%{repository_template_name}
+sync = %{repository_template_sync}
+</pre>
+
+<p>Note again the <code>%</code> variables. Percent variables are replaced when creating the repository template file;
+variables using the conventional dollar syntax are written without substitution to the configuration file.</p>
+
diff --git a/doc/configuration/repositories/toplinks.html.part.in b/doc/configuration/repositories/toplinks.html.part.in
index 61a39ac..8a0081b 100644
--- a/doc/configuration/repositories/toplinks.html.part.in
+++ b/doc/configuration/repositories/toplinks.html.part.in
@@ -22,7 +22,7 @@
</td>
<td class="currentpage">
- <a href="###TOPURI###configuration/repositories/vdb.html">VDB</a>
+ <a href="###TOPURI###configuration/repositories/unwritten.html">unwritten</a>
</td>
</tr>
@@ -40,7 +40,7 @@
</td>
<td class="currentpage">
- &nbsp;
+ <a href="###TOPURI###configuration/repositories/vdb.html">VDB</a>
</td>
</tr>
@@ -108,7 +108,7 @@
</td>
<td class="currentpage">
- <a href="###TOPURI###configuration/repositories/unavailable.html">unavailable</a>
+ <a href="###TOPURI###configuration/repositories/repository.html">repository</a>
</td>
<td class="currentpage">
@@ -126,7 +126,7 @@
</td>
<td class="currentpage">
- <a href="###TOPURI###configuration/repositories/unwritten.html">unwritten</a>
+ <a href="###TOPURI###configuration/repositories/unavailable.html">unavailable</a>
</td>
<td class="currentpage">
diff --git a/doc/configuration/repositories/unavailable.html.part b/doc/configuration/repositories/unavailable.html.part
index bf41641..e2add12 100644
--- a/doc/configuration/repositories/unavailable.html.part
+++ b/doc/configuration/repositories/unavailable.html.part
@@ -24,6 +24,10 @@ for <code>unavailable</code> format repositories:</p>
<dd>Any options to be passed to the syncer. Optional.</dd>
</dl>
+<p>On Exherbo, when used in conjunction with <a href="repository.html">repository format repositories</a>, the
+<code>unavailable</code> repository format also allows automatic installation of configuration files for new repository
+files.</p>
+
<h2>Reference Configurations</h2>
<h3>Gentoo</h3>