Skip to content

Commit

Permalink
Merge pull request #458 from ckauhaus/submit/452-document-options
Browse files Browse the repository at this point in the history
Document common options passed along to nix
  • Loading branch information
domenkozar committed Jun 26, 2016
2 parents f0475ec + d8fbe91 commit e6f012a
Show file tree
Hide file tree
Showing 2 changed files with 73 additions and 6 deletions.
10 changes: 6 additions & 4 deletions .gitignore
@@ -1,9 +1,11 @@
*~
*.pyc
.coverage
coverage.xml
examples/*.json
examples/*.lock
html/
*.pyc
result
*.sw[a-z]
tags
tests/test.nixops*
.coverage
coverage.xml
html/
69 changes: 67 additions & 2 deletions doc/manual/nixops.xml
Expand Up @@ -114,6 +114,71 @@ cloud.</para>
</refsection>


<refsection><title>Common options passed along to Nix</title>

<variablelist>

<varlistentry><term><option>-I</option></term>

<listitem><para>Append a directory to the Nix search path.</para></listitem>

</varlistentry>

<varlistentry><term><option>--max-jobs</option></term>

<listitem><para>Set maximum number of concurrent Nix builds.</para>
</listitem>

</varlistentry>

<varlistentry><term><option>--cores</option></term>

<listitem><para>Sets the value of the NIX_BUILD_CORES environment variable
in the invocation of builders</para></listitem>

</varlistentry>

<varlistentry><term><option>--keep-going</option></term>

<listitem><para>Keep going after failed builds.</para></listitem>

</varlistentry>

<varlistentry><term><option>--keep-failed</option></term>

<listitem><para>Keep temporary directories of failed builds.</para></listitem>

</varlistentry>

<varlistentry><term><option>--show-trace</option></term>

<listitem><para>Print a Nix stack trace if evaluation fails.</para></listitem>

</varlistentry>

<varlistentry><term><option>--fallback</option></term>

<listitem><para>Fall back on installation from source.</para></listitem>

</varlistentry>

<varlistentry><term><option>--option</option></term>

<listitem><para>Set a Nix option.</para></listitem>

</varlistentry>

<varlistentry><term><option>--read-only-mode</option></term>

<listitem><para>Run Nix evaluations in read-only mode.</para></listitem>

</varlistentry>

</variablelist>

</refsection>


<refsection><title>Environment variables</title>

<variablelist>
Expand Down Expand Up @@ -1192,7 +1257,7 @@ non-obsolete machines.</para>
The default is to do each machine sequentially.</para></listitem>

</varlistentry>

<varlistentry><term><option>--include</option>
<replaceable>machine-name...</replaceable></term>

Expand Down Expand Up @@ -1348,7 +1413,7 @@ $ nixops mount foo:/data ~/mnt -o transform_symlinks

<refsection><title>Description</title>

<para>This command reboots all non-obsolete machines in parallel.
<para>This command reboots all non-obsolete machines in parallel.
</para>

</refsection>
Expand Down

0 comments on commit e6f012a

Please sign in to comment.