aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2008-10-06 22:21:25 +0100
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2008-10-06 22:21:25 +0100
commitd9ca0b91f76b0a0649ca049702571da933c165b4 (patch)
tree18d599a3ebab66dd582a1149209322bb2b24eec8
parentef08a256e4c922d7dbb3b34ee9e5e0dbb52088af (diff)
downloadpaludis-d9ca0b91f76b0a0649ca049702571da933c165b4.tar.gz
paludis-d9ca0b91f76b0a0649ca049702571da933c165b4.tar.xz
Document unwritten
-rw-r--r--.gitignore2
-rw-r--r--doc/configuration/Makefile.am15
-rw-r--r--doc/configuration/index.html.part1
-rw-r--r--doc/configuration/unwritten.html.part.in36
-rw-r--r--doc/index.html.part.in1
5 files changed, 54 insertions, 1 deletions
diff --git a/.gitignore b/.gitignore
index bf7b536..b9dc3fa 100644
--- a/.gitignore
+++ b/.gitignore
@@ -124,6 +124,8 @@ man-*
/doc/configuration/toplinks.html.part
/doc/configuration/unavailable.html
/doc/configuration/unavailable.html.part
+/doc/configuration/unwritten.html
+/doc/configuration/unwritten.html.part
/doc/configuration/use.html
/doc/configuration/use.html.part
/doc/configuration/vdb.html
diff --git a/doc/configuration/Makefile.am b/doc/configuration/Makefile.am
index d92709f..205acdd 100644
--- a/doc/configuration/Makefile.am
+++ b/doc/configuration/Makefile.am
@@ -44,7 +44,9 @@ CLEANFILES = *~ gmon.out *.gcov *.gcno *.gcda *.loT \
exndbam.html \
exndbam.html.part \
unavailable.html \
- unavailable.html.part
+ unavailable.html.part \
+ unwritten.html \
+ unwritten.html.part
MAINTAINERCLEANFILES = Makefile.in
@@ -71,6 +73,7 @@ EXTRA_DIST = \
erepository.html.part.in \
installedunpackaged.html.part.in \
unavailable.html.part.in \
+ unwritten.html.part.in \
vdb.html.part.in \
exndbam.html.part.in
@@ -97,6 +100,7 @@ paludisconfigurationhtml_DATA = \
erepository.html \
installedunpackaged.html \
unavailable.html \
+ unwritten.html \
vdb.html \
exndbam.html
@@ -185,6 +189,12 @@ unavailable.html.part : $(srcdir)/unavailable.html.part.in $(srcdir)/paludisenvi
-e 's,###PALUDISENVIRONMENTONLY###,,g' \
< $(srcdir)/unavailable.html.part.in > unavailable.html.part
+unwritten.html.part : $(srcdir)/unwritten.html.part.in $(srcdir)/paludisenvironmentonly.html.part
+ sed \
+ -e '/###PALUDISENVIRONMENTONLY###/r $(srcdir)/paludisenvironmentonly.html.part' \
+ -e 's,###PALUDISENVIRONMENTONLY###,,g' \
+ < $(srcdir)/unwritten.html.part.in > unwritten.html.part
+
installedunpackaged.html.part : $(srcdir)/installedunpackaged.html.part.in $(srcdir)/paludisenvironmentonly.html.part
sed \
-e '/###PALUDISENVIRONMENTONLY###/r $(srcdir)/paludisenvironmentonly.html.part' \
@@ -302,6 +312,9 @@ installedunpackaged.html : header.html.part installedunpackaged.html.part footer
unavailable.html : header.html.part unavailable.html.part footer.html.part
cat header.html.part unavailable.html.part footer.html.part > $@
+unwritten.html : header.html.part unwritten.html.part footer.html.part
+ cat header.html.part unwritten.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 > $@
diff --git a/doc/configuration/index.html.part b/doc/configuration/index.html.part
index 1f98357..085a3a9 100644
--- a/doc/configuration/index.html.part
+++ b/doc/configuration/index.html.part
@@ -39,5 +39,6 @@
<li>... and configuration keys for <a href="exndbam.html">exndbam repositories</a>.</li>
<li>... and configuration keys for <a href="installedunpackaged.html">installed unpackaged repositories</a>.</li>
<li>... and configuration keys for <a href="unavailable.html">unavailable repositories</a>.</li>
+ <li>... and configuration keys for <a href="unwritten.html">unwritten repositories</a>.</li>
</ul>
diff --git a/doc/configuration/unwritten.html.part.in b/doc/configuration/unwritten.html.part.in
new file mode 100644
index 0000000..9879556
--- /dev/null
+++ b/doc/configuration/unwritten.html.part.in
@@ -0,0 +1,36 @@
+<!-- vim: set tw=120 ft=html sw=4 sts=4 et : -->
+
+<h1>unwritten Options</h1>
+
+###PALUDISENVIRONMENTONLY###
+
+<p>As well as the general keys supported for all repositories, the following
+keys have meaning for unwritten 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 is the official unwritten list:</p>
+
+<pre>
+format = unwritten
+location = /var/db/paludis/repositories/unwritten
+sync = git://git.exherbo.org/unwritten.git
+importance = -100
+</pre>
+
diff --git a/doc/index.html.part.in b/doc/index.html.part.in
index d836054..dd4b2c8 100644
--- a/doc/index.html.part.in
+++ b/doc/index.html.part.in
@@ -70,6 +70,7 @@ the exheres repository format.</p>
<li>... and configuration keys for <a href="configuration/exndbam.html">Exndbam repositories</a>.</li>
<li>... and configuration keys for <a href="configuration/installedunpackaged.html">installed unpackaged repositories</a>.</li>
<li>... and configuration keys for <a href="configuration/unavailable.html">unavailable repositories</a>.</li>
+ <li>... and configuration keys for <a href="configuration/unwritten.html">unwritten repositories</a>.</li>
</ul>
<h2>Client Documentation</h2>