aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2009-01-26 19:00:18 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2009-01-26 19:23:47 +0000
commite08cf92049b17fe6b9fe71387adb0bf92b21568d (patch)
treeb200d23e0cbdf9e1adf2c57ec2fcf60b78897158
parent7a7482b44bdd308e787ee1b28fa13474fc888339 (diff)
downloadpaludis-e08cf92049b17fe6b9fe71387adb0bf92b21568d.tar.gz
paludis-e08cf92049b17fe6b9fe71387adb0bf92b21568d.tar.xz
document unwritten
-rw-r--r--.gitignore1
-rw-r--r--doc/configuration/repositories/Makefile.am6
-rw-r--r--doc/configuration/repositories/index.html.part1
-rw-r--r--doc/configuration/repositories/toplinks.html.part.in4
-rw-r--r--doc/configuration/repositories/unwritten.html.part38
5 files changed, 48 insertions, 2 deletions
diff --git a/.gitignore b/.gitignore
index c3990c7..ee2c266 100644
--- a/.gitignore
+++ b/.gitignore
@@ -132,6 +132,7 @@ paludis-*.*.*.tar.bz2
/doc/configuration/repositories/installed_unpackaged.html
/doc/configuration/repositories/toplinks.html.part
/doc/configuration/repositories/unavailable.html
+/doc/configuration/repositories/unwritten.html
/doc/configuration/repositories/vdb.html
/doc/faq/different.html
/doc/faq/footer.html.part
diff --git a/doc/configuration/repositories/Makefile.am b/doc/configuration/repositories/Makefile.am
index 7a9eaf4..07fcc82 100644
--- a/doc/configuration/repositories/Makefile.am
+++ b/doc/configuration/repositories/Makefile.am
@@ -11,6 +11,7 @@ CLEANFILES = *~ gmon.out *.gcov *.gcno *.gcda *.loT *.epicfail \
installed_accounts.html \
installed_unpackaged.html \
unavailable.html \
+ unwritten.html \
vdb.html
MAINTAINERCLEANFILES = Makefile.in
@@ -26,6 +27,7 @@ EXTRA_DIST = \
installed_accounts.html \
installed_unpackaged.html \
unavailable.html \
+ unwritten.html \
vdb.html
paludisconfigurationrepositorieshtmldir = $(htmldir)/configuration/repositories/
@@ -38,6 +40,7 @@ paludisconfigurationrepositorieshtml_DATA = \
installed_accounts.html \
installed_unpackaged.html \
unavailable.html \
+ unwritten.html \
vdb.html
if HAVE_HTMLTIDY
@@ -68,6 +71,9 @@ installed_unpackaged.html : header.html.part $(srcdir)/installed_unpackaged.html
unavailable.html : header.html.part $(srcdir)/unavailable.html.part footer.html.part
cat header.html.part $(srcdir)/unavailable.html.part footer.html.part > $@
+unwritten.html : header.html.part $(srcdir)/unwritten.html.part footer.html.part
+ cat header.html.part $(srcdir)/unwritten.html.part footer.html.part > $@
+
vdb.html : header.html.part $(srcdir)/vdb.html.part footer.html.part
cat header.html.part $(srcdir)/vdb.html.part footer.html.part > $@
diff --git a/doc/configuration/repositories/index.html.part b/doc/configuration/repositories/index.html.part
index 7266ef2..d829841 100644
--- a/doc/configuration/repositories/index.html.part
+++ b/doc/configuration/repositories/index.html.part
@@ -83,5 +83,6 @@ 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="unwritten.html">unwritten</a>, for packages that have yet to be written.</li>
</ul>
diff --git a/doc/configuration/repositories/toplinks.html.part.in b/doc/configuration/repositories/toplinks.html.part.in
index f5f283a..61a39ac 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">
- &nbsp;
+ <a href="###TOPURI###configuration/repositories/vdb.html">VDB</a>
</td>
</tr>
@@ -126,7 +126,7 @@
</td>
<td class="currentpage">
- <a href="###TOPURI###configuration/repositories/vdb.html">VDB</a>
+ <a href="###TOPURI###configuration/repositories/unwritten.html">unwritten</a>
</td>
<td class="currentpage">
diff --git a/doc/configuration/repositories/unwritten.html.part b/doc/configuration/repositories/unwritten.html.part
new file mode 100644
index 0000000..f16a961
--- /dev/null
+++ b/doc/configuration/repositories/unwritten.html.part
@@ -0,0 +1,38 @@
+<!-- vim: set tw=120 ft=html sw=4 sts=4 et : -->
+
+<h1>unwritten Repository Format</h1>
+
+<p>The <code>unwritten</code> repository format is used by Exherbo to keep track of packages that have not yet been
+written. It is not used by Gentoo and derived distributions.</p>
+
+<p>As well as the <a href="index.html">general keys supported for all repositories</a>, the following keys have meaning
+for <code>unwritten</code> format repositories:</p>
+
+<dl>
+ <dt><code>location</code></dt>
+ <dd>The location of the repository. Mandatory.</dd>
+
+ <dt><code>name</code></dt>
+ <dd>The name of the repository. Defaults to <code>unwritten</code>.</dd>
+
+ <dt><code>sync</code></dt>
+ <dd>How to sync the repository. See <a href="../syncers.html">Syncers</a> for supported formats.</dd>
+
+ <dt><code>sync_options</code></dt>
+ <dd>Any options to be passed to the syncer. Optional.</dd>
+</dl>
+
+<h2>Reference Configurations</h2>
+
+<h3>Exherbo</h3>
+
+<p>The following lists all officially unwritten repositories:</p>
+
+<pre>
+format = unwritten
+location = /var/db/paludis/repositories/unwritten
+sync = git://git.exherbo.org/unwritten.git
+importance = -100
+</pre>
+
+