aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJohn Ericson <John.Ericson@Obsidian.Systems>2020-06-17 03:39:39 +0000
committerJohn Ericson <John.Ericson@Obsidian.Systems>2020-06-17 03:39:39 +0000
commit49308ef0397a3da04ae1822188b1fedc70a33243 (patch)
tree96bb06a039bcf472b1f3796bcb4b534df3f732ad /doc
parent74b251b2f3d6414de051c8523011c0ee3c5ea154 (diff)
parent29542865cee37ab22efe1bd142900b69f6c59f0d (diff)
Merge remote-tracking branch 'upstream/master' into ca-drv
Diffstat (limited to 'doc')
-rw-r--r--doc/manual/command-ref/opt-common-syn.xml6
-rw-r--r--doc/manual/command-ref/opt-common.xml31
2 files changed, 36 insertions, 1 deletions
diff --git a/doc/manual/command-ref/opt-common-syn.xml b/doc/manual/command-ref/opt-common-syn.xml
index b610b54b9..2660e3bb1 100644
--- a/doc/manual/command-ref/opt-common-syn.xml
+++ b/doc/manual/command-ref/opt-common-syn.xml
@@ -1,5 +1,5 @@
<nop xmlns="http://docbook.org/ns/docbook">
-
+
<arg><option>--help</option></arg>
<arg><option>--version</option></arg>
<arg rep='repeat'>
@@ -12,6 +12,10 @@
<arg choice='plain'><option>--quiet</option></arg>
</arg>
<arg>
+ <option>--log-format</option>
+ <replaceable>format</replaceable>
+</arg>
+<arg>
<group choice='plain'>
<arg choice='plain'><option>--no-build-output</option></arg>
<arg choice='plain'><option>-Q</option></arg>
diff --git a/doc/manual/command-ref/opt-common.xml b/doc/manual/command-ref/opt-common.xml
index 0383bfaed..a68eef1d0 100644
--- a/doc/manual/command-ref/opt-common.xml
+++ b/doc/manual/command-ref/opt-common.xml
@@ -92,6 +92,37 @@
</varlistentry>
+<varlistentry xml:id="opt-log-format"><term><option>--log-format</option> <replaceable>format</replaceable></term>
+
+ <listitem>
+
+ <para>This option can be used to change the output of the log format, with
+ <replaceable>format</replaceable> being one of:</para>
+
+ <variablelist>
+
+ <varlistentry><term>raw</term>
+ <listitem><para>This is the raw format, as outputted by nix-build.</para></listitem>
+ </varlistentry>
+
+ <varlistentry><term>internal-json</term>
+ <listitem><para>Outputs the logs in a structured manner. NOTE: the json schema is not guarantees to be stable between releases.</para></listitem>
+ </varlistentry>
+
+ <varlistentry><term>bar</term>
+ <listitem><para>Only display a progress bar during the builds.</para></listitem>
+ </varlistentry>
+
+ <varlistentry><term>bar-with-logs</term>
+ <listitem><para>Display the raw logs, with the progress bar at the bottom.</para></listitem>
+ </varlistentry>
+
+ </variablelist>
+
+ </listitem>
+
+</varlistentry>
+
<varlistentry><term><option>--no-build-output</option> / <option>-Q</option></term>
<listitem><para>By default, output written by builders to standard