aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2010-07-27 17:56:41 +0100
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2010-07-27 17:56:41 +0100
commite88b99bff24bf53890eaee3e695375bb669e1ed7 (patch)
treef4468297ba4841476150fc4df4bae0abea246200
parent9bb28ab9454b1c4553bf66f9d3722dec4e96bc7c (diff)
downloadpaludis-e88b99bff24bf53890eaee3e695375bb669e1ed7.tar.gz
paludis-e88b99bff24bf53890eaee3e695375bb669e1ed7.tar.xz
Docs updates for Gentoo r^2
-rw-r--r--doc/configuration/repositories/index.html.part5
-rw-r--r--doc/configuration/repositories/repository.html.part25
-rw-r--r--doc/faq/different.html.part24
3 files changed, 36 insertions, 18 deletions
diff --git a/doc/configuration/repositories/index.html.part b/doc/configuration/repositories/index.html.part
index 0c12933..0ced1d5 100644
--- a/doc/configuration/repositories/index.html.part
+++ b/doc/configuration/repositories/index.html.part
@@ -50,6 +50,8 @@ other keys.</p>
<h3>For All Distributions</h3>
<ul>
+ <li><a href="e.html">e</a> format, for ebuild and exheres repositories.</li>
+ <li><a href="repository.html">repository</a>, for automatic repository configuration.</li>
<li><a href="unavailable.html">unavailable</a>, for information about ebuilds that are present in an overlay or
supplemental repository that is not configured on this system.</li>
<li><a href="installed_unpackaged.html">installed_unpackaged</a>, for tracking installs of packages installed
@@ -59,7 +61,6 @@ other keys.</p>
<h3>Gentoo and Derived Distributions</h3>
<ul>
- <li><a href="e.html">e</a> format, for ebuild repositories.</li>
<li><a href="vdb.html">VDB</a>, for tracking installed ebuilds.</li>
</ul>
@@ -79,11 +80,9 @@ old-style virtuals:</p>
<h3>Exherbo</h3>
<ul>
- <li><a href="e.html">e</a> format, for exheres repositories.</li>
<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
index a4ccffc..138b032 100644
--- a/doc/configuration/repositories/repository.html.part
+++ b/doc/configuration/repositories/repository.html.part
@@ -4,7 +4,7 @@
<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>
+using packages named like <code>repository/foo</code>. It is supported on Exherbo and Gentoo.</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>
@@ -22,14 +22,31 @@ for <code>repository</code> format repositories:</p>
<h2>Repository Template</h2>
-<p>A typical <code>/etc/paludis/repository.template</code> will look like:</p>
+<p>On Gentoo, 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}
+master_repository = gentoo
</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>
+<p>Note that after a repository is 'installed', it may be necessary to remove the <code>master_repository</code> line
+from the generated repository configuration if a repository specifies its own masters via <code>layout.conf</code>.
+Paludis will issue a warning when this is necessary.
+
+<p>On Exherbo, 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>There is no need to specify a <code>master_repository</code>, since all Exherbo repositories specify their own
+masters.</p>
+
+<p>In both cases, 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/faq/different.html.part b/doc/faq/different.html.part
index 7b6f17b..5f29022 100644
--- a/doc/faq/different.html.part
+++ b/doc/faq/different.html.part
@@ -10,7 +10,7 @@
<li><a href="different.html#elog">ELOG Equivalent</a></li>
<li><a href="different.html#mkdir">No Automatic Directory Creation</a></li>
<li><a href="different.html#revdep_rebuild">Revdep-rebuild Equivalent</a></li>
- <li><a href="different.html#playman">No Layman (and how Playman is different)</a></li>
+ <li><a href="different.html#layman">Alternatives to Layman</a></li>
<li><a href="different.html#package_provided">No <code>package.provided</code> file</a></li>
</ul>
@@ -96,18 +96,20 @@ local root access.</p>
<p>Use the <code>reconcilio</code> client.</p>
-<h2 id="playman">No Layman (and how Playman is different)</h2>
+<h2 id="layman">Alternatives to Layman</h2>
-<p>Many gentoo projects and developers maintain ebuild overlays which can be
-configured with the <code>layman</code> tool. Layman will not work with a
-paludis configuration. Instead, you should use the <code>playman</code> tool.
-Unlike layman, playman only creates the necessary configuration for the overlay,
-and is not used to sync it. A regular <code>paludis --sync</code> will sync your
-main repository as well as your overlays.</p>
+<p>Portage does not natively support multiple repositories, so the <code>layman</code> tool is used to hack around this.
+Since Paludis does support multiple repositories, there is no need for a fancy tool to manage and sync overlays.</p>
-<p>To get playman, just install paludis 0.26.0_alpha13 or later with the ruby-bindings
-USE flag enabled. The script will be installed as /usr/bin/playman.
-<code>playman --help</code> describes the available options.</p>
+<p>Adding a repository to Paludis simply requires an appropriate configuration file to be created, and then a normal
+sync to be carried out. It is possible to create repository configuration files by hand; however, an automated method is
+available which simplifies things considerably. To enable the automated method, simply ensure that the <a
+ href="../configuration/repositories/unavailable.html">unavailable</a> and <a
+ href="../configuration/repositories/repository.html">repository</a> repositories have been configured, and then a
+repository can automatically by configured simply by installing <code>repository/somerepo</code>.</p>
+
+<p>Note that previously, a script named <code>playman</code> was used for this purpose; the automatic method is now
+considered preferable.</p>
<h2 id="package_provided">No <code>package.provided</code> file</h2>