aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2010-08-18 10:15:53 +0100
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2010-08-22 09:46:17 +0100
commit1f139106854e161569f8e24ac7c0283e42bdb9be (patch)
treef4340ab922baa93f6b4e3a21b226b5d08d31b480
parent3acc707fdddab596f8e8fa88834d4fe160ceca40 (diff)
downloadpaludis-1f139106854e161569f8e24ac7c0283e42bdb9be.tar.gz
paludis-1f139106854e161569f8e24ac7c0283e42bdb9be.tar.xz
Document output.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/output.html.part.in21
-rw-r--r--doc/configuration/toplinks.html.part.in10
-rw-r--r--doc/index.html.part.in1
6 files changed, 43 insertions, 5 deletions
diff --git a/.gitignore b/.gitignore
index 81b4f1b..01b70b6 100644
--- a/.gitignore
+++ b/.gitignore
@@ -160,6 +160,8 @@ paludis-*.*.*.tar.bz2
/doc/configuration/licenses.html.part
/doc/configuration/mirrors.html
/doc/configuration/mirrors.html.part
+/doc/configuration/output.html
+/doc/configuration/output.html.part
/doc/configuration/packagemask.html
/doc/configuration/packagemask.html.part
/doc/configuration/repositories.html
diff --git a/doc/configuration/Makefile.am b/doc/configuration/Makefile.am
index e518e2c..acdfb3a 100644
--- a/doc/configuration/Makefile.am
+++ b/doc/configuration/Makefile.am
@@ -21,6 +21,8 @@ CLEANFILES += \
general.html.part \
keywords.html \
keywords.html.part \
+ output.html \
+ output.html.part \
packagemask.html \
packagemask.html.part \
use.html \
@@ -46,6 +48,7 @@ EXTRA_DIST = \
specpath.html.part.in \
general.html.part.in \
keywords.html.part.in \
+ output.html.part.in \
packagemask.html.part.in \
licenses.html.part.in \
mirrors.html.part.in \
@@ -69,6 +72,7 @@ paludisconfigurationhtml_DATA = \
keywords.html \
packagemask.html \
mirrors.html \
+ output.html \
bashrc.html \
licenses.html \
use.html \
@@ -173,6 +177,12 @@ mirrors.html.part : $(srcdir)/mirrors.html.part.in $(srcdir)/paludisenvironmento
-e 's,###PALUDISENVIRONMENTONLY###,,g' \
< $(srcdir)/mirrors.html.part.in > mirrors.html.part
+output.html.part : $(srcdir)/output.html.part.in $(srcdir)/paludisenvironmentonly.html.part
+ sed \
+ -e '/###PALUDISENVIRONMENTONLY###/r $(srcdir)/paludisenvironmentonly.html.part' \
+ -e 's,###PALUDISENVIRONMENTONLY###,,g' \
+ < $(srcdir)/output.html.part.in > output.html.part
+
bashrc.html.part : $(srcdir)/bashrc.html.part.in $(srcdir)/paludisenvironmentonly.html.part
sed \
-e '/###PALUDISENVIRONMENTONLY###/r $(srcdir)/paludisenvironmentonly.html.part' \
@@ -215,6 +225,9 @@ packagemask.html : header.html.part packagemask.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 > $@
+output.html : header.html.part output.html.part footer.html.part
+ cat header.html.part output.html.part footer.html.part > $@
+
bashrc.html : header.html.part bashrc.html.part footer.html.part
cat header.html.part bashrc.html.part footer.html.part > $@
diff --git a/doc/configuration/index.html.part b/doc/configuration/index.html.part
index 5aaf19b..a321aa1 100644
--- a/doc/configuration/index.html.part
+++ b/doc/configuration/index.html.part
@@ -30,6 +30,7 @@
<li><a href="use.html">use.conf or options.conf</a>: for USE flags or options.</li>
<li><a href="licenses.html">licenses.conf or licences.conf</a>: for licence filtering.</li>
<li><a href="mirrors.html">mirrors.conf</a>: for mirrors.</li>
+ <li><a href="output.html">output.conf</a>: for output configuration and logging.</li>
<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>
diff --git a/doc/configuration/output.html.part.in b/doc/configuration/output.html.part.in
new file mode 100644
index 0000000..7a52242
--- /dev/null
+++ b/doc/configuration/output.html.part.in
@@ -0,0 +1,21 @@
+<!-- vim: set tw=120 ft=html sw=4 sts=4 et : -->
+
+<h1>output.conf</h1>
+
+###PALUDISENVIRONMENTONLY###
+
+<p>The <code>output.conf</code> file controls how Paludis handles output from subcommands such as building and
+installing a package, or syncing a repository.</p>
+
+<p>There are currently two basic settings that can be set in <code>output.conf</code>:</p>
+
+<pre>
+# always_keep_output_logs may be set to 'true' to always keep output logs, even
+# if a build succeeds.
+always_keep_output_logs = false
+
+# quiet may be set to 'true' to show only messages, rather than all output, when
+# carrying out an action.
+quiet = false
+</pre>
+
diff --git a/doc/configuration/toplinks.html.part.in b/doc/configuration/toplinks.html.part.in
index de46f80..380d86a 100644
--- a/doc/configuration/toplinks.html.part.in
+++ b/doc/configuration/toplinks.html.part.in
@@ -22,7 +22,7 @@
</td>
<td class="currentpage">
- <a href="###TOPURI###configuration/sets.html">sets/</a>
+ <a href="###TOPURI###configuration/bashrc.html">bashrc</a>
</td>
</tr>
@@ -40,7 +40,7 @@
</td>
<td class="currentpage">
- <a href="###TOPURI###configuration/repositories/index.html">repositories/</a>
+ <a href="###TOPURI###configuration/sets.html">sets/</a>
</td>
</tr>
@@ -58,7 +58,7 @@
</td>
<td class="currentpage">
- &nbsp;
+ <a href="###TOPURI###configuration/repositories/index.html">repositories/</a>
</td>
</tr>
@@ -108,7 +108,7 @@
</td>
<td class="currentpage">
- <a href="###TOPURI###configuration/packagemask.html">package_mask.conf</a>
+ <a href="###TOPURI###configuration/output.html">output.conf</a>
</td>
<td class="currentpage">
@@ -126,7 +126,7 @@
</td>
<td class="currentpage">
- <a href="###TOPURI###configuration/bashrc.html">bashrc</a>
+ <a href="###TOPURI###configuration/packagemask.html">package_mask.conf</a>
</td>
<td class="currentpage">
diff --git a/doc/index.html.part.in b/doc/index.html.part.in
index 79a8678..d9566e0 100644
--- a/doc/index.html.part.in
+++ b/doc/index.html.part.in
@@ -66,6 +66,7 @@ the exheres repository format.</p>
<li><a href="configuration/use.html">use.conf or options.conf</a>: for USE flags or options.</li>
<li><a href="configuration/licenses.html">licenses.conf or licences.conf</a>: for licence filtering.</li>
<li><a href="configuration/mirrors.html">mirrors.conf</a>: for mirrors.</li>
+ <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/sets.html">sets/*.conf</a>: for user defined package sets.</li>