summaryrefslogtreecommitdiffstats
path: root/nixos/doc
diff options
context:
space:
mode:
authorEelco Dolstra <edolstra@gmail.com>2020-02-10 16:44:54 +0100
committerGitHub <noreply@github.com>2020-02-10 16:44:54 +0100
commit0e6ceb87584feec4836975d8216f9ca4c2199e0e (patch)
tree83e9859cafd75d68cd8dcef000295a18b9a3fce3 /nixos/doc
parent14e842ec021ea18618f893fea8e7ce332f858a4a (diff)
parenta1fa9e65cab889c4f45e5966d25e45639fc3381b (diff)
Merge pull request #68897 from edolstra/master
Flake support
Diffstat (limited to 'nixos/doc')
-rw-r--r--nixos/doc/manual/man-nixos-rebuild.xml59
-rw-r--r--nixos/doc/manual/man-nixos-version.xml29
2 files changed, 78 insertions, 10 deletions
diff --git a/nixos/doc/manual/man-nixos-rebuild.xml b/nixos/doc/manual/man-nixos-rebuild.xml
index 495dbc8859b1..f4f663b84f05 100644
--- a/nixos/doc/manual/man-nixos-rebuild.xml
+++ b/nixos/doc/manual/man-nixos-rebuild.xml
@@ -77,7 +77,14 @@
<option>--builders</option> <replaceable>builder-spec</replaceable>
</arg>
+ <sbr/>
+
+ <arg>
+ <option>--flake</option> <replaceable>flake-uri</replaceable>
+ </arg>
+
<sbr />
+
<arg>
<group choice='req'>
<arg choice='plain'>
@@ -129,14 +136,17 @@
<title>Description</title>
<para>
- This command updates the system so that it corresponds to the configuration
- specified in <filename>/etc/nixos/configuration.nix</filename>. Thus, every
- time you modify <filename>/etc/nixos/configuration.nix</filename> or any
- NixOS module, you must run <command>nixos-rebuild</command> to make the
- changes take effect. It builds the new system in
- <filename>/nix/store</filename>, runs its activation script, and stop and
- (re)starts any system services if needed. Please note that user services need
- to be started manually as they aren't detected by the activation script at the moment.
+ This command updates the system so that it corresponds to the
+ configuration specified in
+ <filename>/etc/nixos/configuration.nix</filename> or
+ <filename>/etc/nixos/flake.nix</filename>. Thus, every time you
+ modify the configuration or any other NixOS module, you must run
+ <command>nixos-rebuild</command> to make the changes take
+ effect. It builds the new system in
+ <filename>/nix/store</filename>, runs its activation script, and
+ stop and (re)starts any system services if needed. Please note that
+ user services need to be started manually as they aren't detected
+ by the activation script at the moment.
</para>
<para>
@@ -508,6 +518,24 @@
</para>
</listitem>
</varlistentry>
+
+ <varlistentry>
+ <term>
+ <option>--flake</option> <replaceable>flake-uri</replaceable>[<replaceable>name</replaceable>]
+ </term>
+ <listitem>
+ <para>
+ Build the NixOS system from the specified flake. It defaults to
+ the directory containing the target of the symlink
+ <filename>/etc/nixos/flake.nix</filename>, if it exists. The
+ flake must contain an output named
+ <literal>nixosConfigurations.<replaceable>name</replaceable></literal>. If
+ <replaceable>name</replaceable> is omitted, it default to the
+ current host name.
+ </para>
+ </listitem>
+ </varlistentry>
+
</variablelist>
<para>
@@ -556,6 +584,21 @@
<varlistentry>
<term>
+ <filename>/etc/nixos/flake.nix</filename>
+ </term>
+ <listitem>
+ <para>
+ If this file exists, then <command>nixos-rebuild</command> will
+ use it as if the <option>--flake</option> option was given. This
+ file may be a symlink to a <filename>flake.nix</filename> in an
+ actual flake; thus <filename>/etc/nixos</filename> need not be a
+ flake.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
<filename>/run/current-system</filename>
</term>
<listitem>
diff --git a/nixos/doc/manual/man-nixos-version.xml b/nixos/doc/manual/man-nixos-version.xml
index e9ad8bddcace..aada08c5b4a9 100644
--- a/nixos/doc/manual/man-nixos-version.xml
+++ b/nixos/doc/manual/man-nixos-version.xml
@@ -12,16 +12,22 @@
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
- <command>nixos-version</command>
+ <command>nixos-version</command>
<arg>
<option>--hash</option>
</arg>
-
+
<arg>
<option>--revision</option>
</arg>
+
+ <arg>
+ <option>--json</option>
+ </arg>
+
</cmdsynopsis>
</refsynopsisdiv>
+
<refsection>
<title>Description</title>
<para>
@@ -84,12 +90,16 @@
</variablelist>
</para>
</refsection>
+
<refsection>
<title>Options</title>
+
<para>
This command accepts the following options:
</para>
+
<variablelist>
+
<varlistentry>
<term>
<option>--hash</option>
@@ -107,6 +117,21 @@
</para>
</listitem>
</varlistentry>
+
+ <varlistentry>
+ <term>
+ <option>--json</option>
+ </term>
+ <listitem>
+ <para>
+ Print a JSON representation of the versions of NixOS and the
+ top-level configuration flake.
+ </para>
+ </listitem>
+ </varlistentry>
+
</variablelist>
+
</refsection>
+
</refentry>