aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2008-09-03 17:07:37 +0100
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2008-09-03 17:10:28 +0100
commitaf3cb24e89302e9b6cb04f15eb6c53aae5be2eb6 (patch)
tree11e19f7d11d2b85e96a7d27e521b8099122d9607
parent374b0b7d25ff98be8ba05352599fe493b81cf0c3 (diff)
downloadpaludis-af3cb24e89302e9b6cb04f15eb6c53aae5be2eb6.tar.gz
paludis-af3cb24e89302e9b6cb04f15eb6c53aae5be2eb6.tar.xz
Documentation updates
Document unavailable, turn it on by default. Fix examples links. Fixes: ticket:641
-rw-r--r--.gitignore2
-rw-r--r--configure.ac2
-rw-r--r--doc/api/index.html.part14
-rw-r--r--doc/configuration/Makefile.am15
-rw-r--r--doc/configuration/index.html.part1
-rw-r--r--doc/configuration/unavailable.html.part.in48
-rw-r--r--doc/index.html.part.in4
-rw-r--r--doc/overview/gettingstarted.html.part19
8 files changed, 87 insertions, 18 deletions
diff --git a/.gitignore b/.gitignore
index 56384ba..bf7b536 100644
--- a/.gitignore
+++ b/.gitignore
@@ -122,6 +122,8 @@ man-*
/doc/configuration/syncers.html.part
/doc/configuration/synclist
/doc/configuration/toplinks.html.part
+/doc/configuration/unavailable.html
+/doc/configuration/unavailable.html.part
/doc/configuration/use.html
/doc/configuration/use.html.part
/doc/configuration/vdb.html
diff --git a/configure.ac b/configure.ac
index ddaf90c..0c7d7f6 100644
--- a/configure.ac
+++ b/configure.ac
@@ -1153,7 +1153,7 @@ dnl }}}
dnl {{{ repositories
ALL_REPOSITORIES="cran e fake gems unavailable unpackaged virtuals"
-DEFAULT_REPOSITORIES="e fake unpackaged virtuals"
+DEFAULT_REPOSITORIES="e fake unavailable unpackaged virtuals"
AC_MSG_CHECKING([which repositories to build...])
AC_ARG_WITH([repositories],
[ --with-repositories=foo,bar,...
diff --git a/doc/api/index.html.part b/doc/api/index.html.part
index 7f82fdf..3fde978 100644
--- a/doc/api/index.html.part
+++ b/doc/api/index.html.part
@@ -163,20 +163,6 @@ how concepts map on to different language bindings.</p>
<td>How to use PackageID</td>
</tr>
<tr>
- <td>example_query</td>
- <td><a href="cplusplus/example__query_8cc-example.html">C++</a></td>
- <td><a href="ruby/example_query.html">Ruby</a></td>
- <td></td>
- <td>How to use the standard Query classes</td>
- </tr>
- <tr>
- <td>example_query_delegate</td>
- <td><a href="cplusplus/example__query__delegate_8cc-example.html">C++</a></td>
- <td></td>
- <td></td>
- <td>How to implement a new Query classes</td>
- </tr>
- <tr>
<td>example_repository</td>
<td><a href="cplusplus/example__repository_8cc-example.html">C++</a></td>
<td><a href="ruby/example_repository.html">Ruby</a></td>
diff --git a/doc/configuration/Makefile.am b/doc/configuration/Makefile.am
index 8efb706..d92709f 100644
--- a/doc/configuration/Makefile.am
+++ b/doc/configuration/Makefile.am
@@ -42,7 +42,9 @@ CLEANFILES = *~ gmon.out *.gcov *.gcno *.gcda *.loT \
vdb.html \
vdb.html.part \
exndbam.html \
- exndbam.html.part
+ exndbam.html.part \
+ unavailable.html \
+ unavailable.html.part
MAINTAINERCLEANFILES = Makefile.in
@@ -68,6 +70,7 @@ EXTRA_DIST = \
repositories.html.part.in \
erepository.html.part.in \
installedunpackaged.html.part.in \
+ unavailable.html.part.in \
vdb.html.part.in \
exndbam.html.part.in
@@ -93,6 +96,7 @@ paludisconfigurationhtml_DATA = \
repositories.html \
erepository.html \
installedunpackaged.html \
+ unavailable.html \
vdb.html \
exndbam.html
@@ -175,6 +179,12 @@ erepository.html.part : $(srcdir)/erepository.html.part.in $(srcdir)/paludisenvi
-e 's,###PALUDISENVIRONMENTONLY###,,g' \
< $(srcdir)/erepository.html.part.in > erepository.html.part
+unavailable.html.part : $(srcdir)/unavailable.html.part.in $(srcdir)/paludisenvironmentonly.html.part
+ sed \
+ -e '/###PALUDISENVIRONMENTONLY###/r $(srcdir)/paludisenvironmentonly.html.part' \
+ -e 's,###PALUDISENVIRONMENTONLY###,,g' \
+ < $(srcdir)/unavailable.html.part.in > unavailable.html.part
+
installedunpackaged.html.part : $(srcdir)/installedunpackaged.html.part.in $(srcdir)/paludisenvironmentonly.html.part
sed \
-e '/###PALUDISENVIRONMENTONLY###/r $(srcdir)/paludisenvironmentonly.html.part' \
@@ -289,6 +299,9 @@ erepository.html : header.html.part erepository.html.part footer.html.part
installedunpackaged.html : header.html.part installedunpackaged.html.part footer.html.part
cat header.html.part installedunpackaged.html.part footer.html.part > $@
+unavailable.html : header.html.part unavailable.html.part footer.html.part
+ cat header.html.part unavailable.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 6b06f80..1f98357 100644
--- a/doc/configuration/index.html.part
+++ b/doc/configuration/index.html.part
@@ -38,5 +38,6 @@
<li>... and configuration keys for <a href="vdb.html">vdb repositories</a>.</li>
<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>
</ul>
diff --git a/doc/configuration/unavailable.html.part.in b/doc/configuration/unavailable.html.part.in
new file mode 100644
index 0000000..bdaf9a6
--- /dev/null
+++ b/doc/configuration/unavailable.html.part.in
@@ -0,0 +1,48 @@
+<!-- vim: set tw=120 ft=html sw=4 sts=4 et : -->
+
+<h1>unavailable Options</h1>
+
+###PALUDISENVIRONMENTONLY###
+
+<p>As well as the general keys supported for all repositories, the following
+keys have meaning for unavailable 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>unavailable</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>Gentoo</h3>
+
+<p>The following makes <code>layman</code> repositories available:</p>
+
+<pre>
+format = unavailable
+name = layman
+location = /var/db/paludis/repositories/layman
+sync = tar+http://git.exherbo.org/layman_repositories.tar.bz2
+importance = -100
+</pre>
+
+<h3>Exherbo</h3>
+
+<p>The following lists all official repositories:</p>
+
+<pre>
+format = unavailable
+location = /var/db/paludis/repositories/unavailable
+sync = tar+http://git.exherbo.org/exherbo_repositories.tar.bz2
+importance = -100
+</pre>
+
diff --git a/doc/index.html.part.in b/doc/index.html.part.in
index e667fad..d836054 100644
--- a/doc/index.html.part.in
+++ b/doc/index.html.part.in
@@ -65,9 +65,11 @@ the exheres repository format.</p>
<li><a href="configuration/bashrc.html">bashrc</a>: for package build environment options.</li>
<li><a href="configuration/sets.html">sets/*.conf</a>: for user defined package sets.</li>
<li><a href="configuration/repositories.html">repositories/*.conf and repository_defaults.conf</a>, in general.</li>
- <li>... and configuration keys for <a href="configuration/erepository.html">ebuild repositories</a>.</li>
+ <li>... and configuration keys for <a href="configuration/erepository.html">ebuild and exheres repositories</a>.</li>
<li>... and configuration keys for <a href="configuration/vdb.html">VDB repositories</a>.</li>
+ <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>
</ul>
<h2>Client Documentation</h2>
diff --git a/doc/overview/gettingstarted.html.part b/doc/overview/gettingstarted.html.part
index 98e88ba..601b2a4 100644
--- a/doc/overview/gettingstarted.html.part
+++ b/doc/overview/gettingstarted.html.part
@@ -70,6 +70,10 @@ script can be used to generate a Paludis configuration from an existing Portage
</code> option for some overlays.</li>
</ul>
+<p>You may also wish to set up an unavailable repository for tracking repositories in layman. See <a
+ href="../configuration/unavailable.html">the unavailable repository documentation</a> for a sample repository
+config.</p>
+
<p>Next, proceed to <a href="#testing">Testing a configuration</a>.</p>
<h2 id="manual">Manually configuring Paludis</h2>
@@ -267,11 +271,17 @@ however, do not provide this.)</p>
<p>For details on <code>sync</code> formats, use <code>paludis --list-sync-protocols</code>. The listed options can be
used via <code>sync_options = </code>.</p>
+<h5>repositories/layman.conf</h5>
+
+<p>You may also wish to set up an unavailable repository for tracking repositories in layman. See <a
+ href="../configuration/unavailable.html">the unavailable repository documentation</a> for a sample repository
+config.</p>
+
<p>Next, proceed to <a href="#testing">Testing a configuration</a>.</p>
<h4>Repositories for Exherbo</h4>
-<p>Exherbo users will need at least the following two repositories:</p>
+<p>Exherbo users will need at least the following three repositories:</p>
<h5>repositories/arbor.conf</h5>
@@ -293,6 +303,13 @@ location = /var/db/paludis/repositories/installed
format = exndbam
</pre>
+<h5>repositories/unavailable.conf</h5>
+
+
+<p>You should usually set up an unavailable repository for tracking repositories that you do not have configured. See <a
+ href="../configuration/unavailable.html">the unavailable repository documentation</a> for a sample repository
+config.</p>
+
<p>Next, proceed to <a href="#testing">Testing a configuration</a>.</p>
<h2 id="testing">Testing a configuration</h2>