aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2008-05-29 10:49:10 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2008-05-29 10:49:10 +0000
commit9a5400a97eb5b657e03c2b0c0afa1a1a8aa3ac3e (patch)
tree5decf635ef2f93b8c1ee4caa4c69becc7dddfa9a
parent9a5a7fb1cb82fc7c90614a80f59c9996d61b5482 (diff)
downloadpaludis-9a5400a97eb5b657e03c2b0c0afa1a1a8aa3ac3e.tar.gz
paludis-9a5400a97eb5b657e03c2b0c0afa1a1a8aa3ac3e.tar.xz
Documentation updates for Exherbo
-rw-r--r--doc/configuration/Makefile.am19
-rw-r--r--doc/configuration/erepository.html.part.in15
-rw-r--r--doc/configuration/exndbam.html.part.in19
-rw-r--r--doc/configuration/index.html.part3
-rw-r--r--doc/index.html.part.in4
-rw-r--r--doc/overview/gettingstarted.html.part43
6 files changed, 87 insertions, 16 deletions
diff --git a/doc/configuration/Makefile.am b/doc/configuration/Makefile.am
index 1ab1f46..1131050 100644
--- a/doc/configuration/Makefile.am
+++ b/doc/configuration/Makefile.am
@@ -40,7 +40,9 @@ CLEANFILES = *~ gmon.out *.gcov *.gcno *.gcda \
installedunpackaged.html \
installedunpackaged.html.part \
vdb.html \
- vdb.html.part
+ vdb.html.part \
+ exndbam.html \
+ exndbam.html.part
MAINTAINERCLEANFILES = Makefile.in
@@ -66,7 +68,8 @@ EXTRA_DIST = \
repositories.html.part.in \
erepository.html.part.in \
installedunpackaged.html.part.in \
- vdb.html.part.in
+ vdb.html.part.in \
+ exndbam.html.part.in
paludisconfigurationhtmldir = $(htmldir)/configuration
@@ -90,7 +93,8 @@ paludisconfigurationhtml_DATA = \
repositories.html \
erepository.html \
installedunpackaged.html \
- vdb.html
+ vdb.html \
+ exndbam.html
if HAVE_HTMLTIDY
@@ -183,6 +187,12 @@ vdb.html.part : $(srcdir)/vdb.html.part.in $(srcdir)/paludisenvironmentonly.html
-e 's,###PALUDISENVIRONMENTONLY###,,g' \
< $(srcdir)/vdb.html.part.in > vdb.html.part
+exndbam.html.part : $(srcdir)/exndbam.html.part.in $(srcdir)/paludisenvironmentonly.html.part
+ sed \
+ -e '/###PALUDISENVIRONMENTONLY###/r $(srcdir)/paludisenvironmentonly.html.part' \
+ -e 's,###PALUDISENVIRONMENTONLY###,,g' \
+ < $(srcdir)/exndbam.html.part.in > exndbam.html.part
+
environment.html.part : $(srcdir)/environment.html.part.in $(srcdir)/paludisenvironmentonly.html.part
sed \
-e '/###PALUDISENVIRONMENTONLY###/r $(srcdir)/paludisenvironmentonly.html.part' \
@@ -282,6 +292,9 @@ installedunpackaged.html : header.html.part installedunpackaged.html.part footer
vdb.html : header.html.part vdb.html.part footer.html.part
cat header.html.part vdb.html.part footer.html.part > $@
+exndbam.html : header.html.part exndbam.html.part footer.html.part
+ cat header.html.part exndbam.html.part footer.html.part > $@
+
syncers.html : header.html.part syncers.html.part footer.html.part
cat header.html.part syncers.html.part footer.html.part > $@
diff --git a/doc/configuration/erepository.html.part.in b/doc/configuration/erepository.html.part.in
index 6c315f3..959e778 100644
--- a/doc/configuration/erepository.html.part.in
+++ b/doc/configuration/erepository.html.part.in
@@ -1,21 +1,22 @@
<!-- vim: set tw=120 ft=html sw=4 sts=4 et : -->
-<h1>ebuild Options</h1>
+<h1>ebuild and exheres Options</h1>
###PALUDISENVIRONMENTONLY###
-<p>As well as the general keys supported for all repositories, the following keys have meaning for ebuild format
-repositories:</p>
+<p>As well as the general keys supported for all repositories, the following keys have meaning for ebuild
+and exheres format repositories:</p>
<dl>
<dt><code>location</code></dt>
<dd>The location of the repository. Mandatory.</dd>
<dt><code>master_repository</code></dt>
- <dd>If set to the name of another ebuild-format repository, that repository is used as a 'master' for any part of
- this repository that is not defined. Also changes the default importance of this repository from 0 to 10. (In
- Portage terms, this is similar to saying that this repository is an overlay with the master as the main repository.
- However, identically named and versioned packages in this repository do not hide those in the master.)</dd>
+ <dd>If set to the name of another ebuild- or exheres-format repository, that repository is used as a 'master' for
+ any part of this repository that is not defined. Also changes the default importance of this repository from 0 to
+ 10. (In Portage terms, this is similar to saying that this repository is an overlay with the master as the main
+ repository. However, identically named and versioned packages in this repository do not hide those in the
+ master.)</dd>
<dt><code>profiles</code></dt>
<dd>A space separated list of directories to use as profiles. Later entries override earlier entries. Inherited from
diff --git a/doc/configuration/exndbam.html.part.in b/doc/configuration/exndbam.html.part.in
new file mode 100644
index 0000000..181d85f
--- /dev/null
+++ b/doc/configuration/exndbam.html.part.in
@@ -0,0 +1,19 @@
+<!-- vim: set tw=120 ft=html sw=4 sts=4 et : -->
+
+<h1>exndbam Options</h1>
+
+###PALUDISENVIRONMENTONLY###
+
+<p>As well as the general keys supported for all repositories, the following keys have meaning for exndbam format
+repositories:</p>
+
+<dl>
+ <dt><code>location</code></dt>
+ <dd>The location of the repository. Mandatory.</dd>
+
+ <dt><code>builddir</code></dt>
+ <dd>The directory to use when 'building' a package for an uninstall (a temporary directory is needed for various
+ operations). Optional.</dd>
+</dl>
+
+
diff --git a/doc/configuration/index.html.part b/doc/configuration/index.html.part
index 9be7287..6b06f80 100644
--- a/doc/configuration/index.html.part
+++ b/doc/configuration/index.html.part
@@ -34,8 +34,9 @@
<li><a href="bashrc.html">bashrc</a>: for package build environment options.</li>
<li><a href="sets.html">sets/*.conf</a>: for user defined package sets.</li>
<li><a href="repositories.html">repositories/*.conf and repository_defaults.conf</a>, in general.</li>
- <li>... and configuration keys for <a href="erepository.html">ebuild repositories</a>.</li>
+ <li>... and configuration keys for <a href="erepository.html">ebuild and exheres repositories</a>.</li>
<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>
</ul>
diff --git a/doc/index.html.part.in b/doc/index.html.part.in
index 5c73955..255aeff 100644
--- a/doc/index.html.part.in
+++ b/doc/index.html.part.in
@@ -10,6 +10,10 @@
<h2>Overview</h2>
+<p>Paludis is a multi-format package manager. It can currently be used on <a href="http://www.gentoo.org/">Gentoo</a>
+and derivatives, using the ebuild and VDB repository formats, and on <a href="http://www.exherbo.org/">Exherbo</a> using
+the exheres repository format.</p>
+
<ul>
<li><a href="overview/features.html">Features</a>: an overview of Paludis, and how it differs from its predecessor,
Portage.</li>
diff --git a/doc/overview/gettingstarted.html.part b/doc/overview/gettingstarted.html.part
index 0351963..f2cc79b 100644
--- a/doc/overview/gettingstarted.html.part
+++ b/doc/overview/gettingstarted.html.part
@@ -87,12 +87,17 @@ mkdir -p /etc/paludis/repositories
<h3>environment.conf</h3>
<p>The file <code>/etc/paludis/environment.conf</code> must, at minimum, specify the location of the world file
-(other options are described elsewhere in the documentation). The usual location for Paludis is:</p>
+(other options are described elsewhere in the documentation). The usual location for Paludis on Gentoo and
+Gentoo-derived systems is:</p>
<pre>world = /var/db/pkg/world</pre>
<p>The option <code>world = /var/lib/portage/world</code> can be set if Portage's world file is to be used.</p>
+<p>On Exherbo systems, we instead use:</p>
+
+<pre>world = /var/db/paludis/world</pre>
+
<h3>keywords.conf</h3>
<p>You will need to make <code>/etc/paludis/keywords.conf</code>:</p>
@@ -178,12 +183,14 @@ reasons, it is strongly recommended that the filename used matches the name of t
<em>the filename you use here has no meaning to Paludis, and does not have to correspond to the repository's
name</em>.</p>
+<h4>Repositories for Gentoo</h4>
+
<p>Gentoo users will need at least the following two repositories:</p>
-<h4>repositories/gentoo.conf</h4>
+<h5>repositories/gentoo.conf</h5>
<p>The main Gentoo repository, sometimes annoyingly called 'the Portage tree' and sometimes historically called
-'gentoo-x86' will typically look like:</p>
+'gentoo-x86', will typically look like:</p>
<pre>
location = /usr/portage
@@ -208,7 +215,7 @@ via <code>--sync</code>) modify a repository.</p>
<p>You are responsible for ensuring that any cache directories you use exist and have appropriate permissions.</p>
-<h4>repositories/installed.conf</h4>
+<h5>repositories/installed.conf</h5>
<p>You also need a repository that holds your installed packages. <strong>You must not change the location of this
repository</strong>; its location is hardcoded in various badly written ebuilds.</p>
@@ -237,7 +244,7 @@ manually if you install or uninstall any package using Portage.</p>
<p>You are responsible for ensuring that any cache directories you use exist and have appropriate permissions.</p>
-<h4>repositories/paludis-overlay.conf</h4>
+<h5>repositories/paludis-overlay.conf</h5>
<p>You might find the Paludis overlay useful, if you need very up to date or live ebuilds. This also illustrates the
typical way to set up what Portage calls an 'overlay':</p>
@@ -262,6 +269,32 @@ used via <code>sync_options = </code>.</p>
<p>Next, proceed to <a href="#testing">Testing a configuration</a>.</p>
+<h4>Repositories for Exherbo</h4>
+
+<p>Gentoo users will need at least the following two repositories:</p>
+
+<h5>repositories/arbor.conf</h5>
+
+<p>The main Exherbo repository is 'arbor':</p>
+
+<pre>
+location = /var/db/paludis/repositories/arbor
+sync = git://git.exherbo.org/arbor.git
+profiles = ${location}/profiles/default-linux/x86/2007.0
+format = exheres
+</pre>
+
+<h5>repositories/installed.conf</h5>
+
+<p>You also need a repository that holds your installed packages.</p>
+
+<pre>
+location = /var/db/paludis/repositories/installed
+format = exndbam
+</pre>
+
+<p>Next, proceed to <a href="#testing">Testing a configuration</a>.</p>
+
<h2 id="testing">Testing a configuration</h2>
<p>To see if a configuration can be used successfully, try:</p>