aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2010-12-17 14:07:51 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2010-12-17 14:07:51 +0000
commita7615b25694a7314b7e1bb238041a9fe4e73f3a5 (patch)
tree2e23fe73b1c0c56a6e9a1822b439b289b0e29f88
parentb868007a6b39d08403075a0778d32f4b885ea2a2 (diff)
downloadpaludis-a7615b25694a7314b7e1bb238041a9fe4e73f3a5.tar.gz
paludis-a7615b25694a7314b7e1bb238041a9fe4e73f3a5.tar.xz
Document suggestions.conf
-rw-r--r--.gitignore2
-rw-r--r--doc/configuration/Makefile.am13
-rw-r--r--doc/configuration/index.html.part1
-rw-r--r--doc/configuration/suggestions.html.part.in46
-rw-r--r--doc/configuration/toplinks.html.part.in6
-rw-r--r--doc/index.html.part.in1
6 files changed, 66 insertions, 3 deletions
diff --git a/.gitignore b/.gitignore
index d7071dd..6e11589 100644
--- a/.gitignore
+++ b/.gitignore
@@ -172,6 +172,8 @@ paludis-*.*.*.tar.bz2
/doc/configuration/output.html.part
/doc/configuration/packagemask.html
/doc/configuration/packagemask.html.part
+/doc/configuration/suggestions.html
+/doc/configuration/suggestions.html.part
/doc/configuration/repositories.html
/doc/configuration/repositories.html.part
/doc/configuration/sets.html
diff --git a/doc/configuration/Makefile.am b/doc/configuration/Makefile.am
index acdfb3a..c9c2f5f 100644
--- a/doc/configuration/Makefile.am
+++ b/doc/configuration/Makefile.am
@@ -25,6 +25,8 @@ CLEANFILES += \
output.html.part \
packagemask.html \
packagemask.html.part \
+ suggestions.html \
+ suggestions.html.part \
use.html \
use.html.part \
licenses.html \
@@ -50,6 +52,7 @@ EXTRA_DIST = \
keywords.html.part.in \
output.html.part.in \
packagemask.html.part.in \
+ suggestions.html.part.in \
licenses.html.part.in \
mirrors.html.part.in \
bashrc.html.part.in \
@@ -71,6 +74,7 @@ paludisconfigurationhtml_DATA = \
general.html \
keywords.html \
packagemask.html \
+ suggestions.html \
mirrors.html \
output.html \
bashrc.html \
@@ -171,6 +175,12 @@ packagemask.html.part : $(srcdir)/packagemask.html.part.in $(srcdir)/paludisenvi
-e 's,###PALUDISENVIRONMENTONLY###,,g' \
< $(srcdir)/packagemask.html.part.in > packagemask.html.part
+suggestions.html.part : $(srcdir)/suggestions.html.part.in $(srcdir)/paludisenvironmentonly.html.part
+ sed \
+ -e '/###PALUDISENVIRONMENTONLY###/r $(srcdir)/paludisenvironmentonly.html.part' \
+ -e 's,###PALUDISENVIRONMENTONLY###,,g' \
+ < $(srcdir)/suggestions.html.part.in > suggestions.html.part
+
mirrors.html.part : $(srcdir)/mirrors.html.part.in $(srcdir)/paludisenvironmentonly.html.part
sed \
-e '/###PALUDISENVIRONMENTONLY###/r $(srcdir)/paludisenvironmentonly.html.part' \
@@ -222,6 +232,9 @@ keywords.html : header.html.part keywords.html.part footer.html.part
packagemask.html : header.html.part packagemask.html.part footer.html.part
cat header.html.part packagemask.html.part footer.html.part > $@
+suggestions.html : header.html.part suggestions.html.part footer.html.part
+ cat header.html.part suggestions.html.part footer.html.part > $@
+
mirrors.html : header.html.part mirrors.html.part footer.html.part
cat header.html.part mirrors.html.part footer.html.part > $@
diff --git a/doc/configuration/index.html.part b/doc/configuration/index.html.part
index a321aa1..7ac7fb4 100644
--- a/doc/configuration/index.html.part
+++ b/doc/configuration/index.html.part
@@ -34,6 +34,7 @@
<li><a href="packagemask.html">package_mask.conf and package_unmask.conf</a>: for masks.</li>
<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="suggestions.html">suggestions.conf</a>: for suggestions.</li>
<li><a href="repositories/index.html">repositories/*.conf and repository_defaults.conf</a></li>
</ul>
diff --git a/doc/configuration/suggestions.html.part.in b/doc/configuration/suggestions.html.part.in
new file mode 100644
index 0000000..cf174b7
--- /dev/null
+++ b/doc/configuration/suggestions.html.part.in
@@ -0,0 +1,46 @@
+<!-- vim: set tw=120 ft=html sw=4 sts=4 et : -->
+
+<h1>suggestions.conf</h1>
+
+###PALUDISENVIRONMENTONLY###
+
+<p>The <code>suggestions.conf</code> file allows suggested dependencies to be automatically taken or ignored. It is a
+standard configuration file which may be a bash file (<code>suggestions.bash</code>) and which may use the
+<code>suggestions.conf.d/</code> directory. Note that suggestions are not generally used on Gentoo.</p>
+
+<p>Each line in the file consists of a specification followed by one or more tokens. A specification may be any of:</p>
+
+<ul>
+ <li>The special specification <code>*/*</code>, which matches all packages.</li>
+ <li>A simple <code>category/package</code> name.</li>
+ <li>A simple <code>set</code> name.</li>
+ <li>A complex dependency specification.</li>
+</ul>
+
+<p>Lines are considered only if the package containing the suggested dependency matches the specification.</p>
+
+<p>A token may be one of the following:</p>
+
+<ul>
+ <li><code>*/*</code>, which says to take all suggestions from the package.</li>
+ <li>A simple <code>cat/pkg</code>, which says to take any suggestions related to the named package. Note that
+ complex dependency specifications may <em>not</em> be used here.</li>
+ <li>A minus sign, followed by either of the above, to discard rather than take the suggestion in question.</li>
+</ul>
+
+<h2>Example</h2>
+
+<pre>
+# We are always interested in some suggestions from kdevelop:
+dev-util/kdevelop dev-util/subversion kde-base/konsole
+
+# We never want some other suggestions from kdevelop:
+dev-util/kdevelop -dev-util/cvs
+
+# We don't want any suggestions on kmail from anything:
+*/* -kde-base/kmail
+
+# Otherwise, we're interested in all kde-base suggestions:
+kde-base/* */*
+</pre>
+
diff --git a/doc/configuration/toplinks.html.part.in b/doc/configuration/toplinks.html.part.in
index 380d86a..251d964 100644
--- a/doc/configuration/toplinks.html.part.in
+++ b/doc/configuration/toplinks.html.part.in
@@ -40,7 +40,7 @@
</td>
<td class="currentpage">
- <a href="###TOPURI###configuration/sets.html">sets/</a>
+ <a href="###TOPURI###configuration/suggestions.html">suggestions.conf</a>
</td>
</tr>
@@ -58,7 +58,7 @@
</td>
<td class="currentpage">
- <a href="###TOPURI###configuration/repositories/index.html">repositories/</a>
+ <a href="###TOPURI###configuration/sets.html">sets/</a>
</td>
</tr>
@@ -76,7 +76,7 @@
</td>
<td class="currentpage">
- &nbsp;
+ <a href="###TOPURI###configuration/repositories/index.html">repositories/</a>
</td>
</tr>
diff --git a/doc/index.html.part.in b/doc/index.html.part.in
index 1707400..7f19a96 100644
--- a/doc/index.html.part.in
+++ b/doc/index.html.part.in
@@ -70,6 +70,7 @@ the exheres repository format.</p>
<li><a href="configuration/output.html">output.conf</a>: for output configuration and logging.</li>
<li><a href="configuration/packagemask.html">package_mask.conf and package_unmask.conf</a>: for masks.</li>
<li><a href="configuration/bashrc.html">bashrc</a>: for package build environment options.</li>
+ <li><a href="configuration/suggestions.html">suggestions.conf</a>: for suggestions.</li>
<li><a href="configuration/sets.html">sets/*.conf</a>: for user defined package sets.</li>
<li><a href="configuration/repositories/index.html">repositories/*.conf and repository_defaults.conf</a></li>
</ul>