about summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorEelco Dolstra <eelco.dolstra@logicblox.com>2012-10-03T19·53-0400
committerEelco Dolstra <eelco.dolstra@logicblox.com>2012-10-03T19·53-0400
commit9c41c66c5b877dbb529f6147b28384a57a591895 (patch)
tree5c0981b91e6e0c3be385a978c2a3bbedad994c1e /doc
parent2bbc4a214ee998816921cefb2d69f30d5f277d12 (diff)
Document ‘--repair’
Diffstat (limited to 'doc')
-rw-r--r--doc/manual/nix-store.xml17
-rw-r--r--doc/manual/opt-common.xml11
-rw-r--r--doc/manual/release-notes.xml10
3 files changed, 32 insertions, 6 deletions
diff --git a/doc/manual/nix-store.xml b/doc/manual/nix-store.xml
index 719bfe097574..22bcb41e8763 100644
--- a/doc/manual/nix-store.xml
+++ b/doc/manual/nix-store.xml
@@ -174,10 +174,19 @@ the specified store paths.  Realisation is a somewhat overloaded term:
 output.  (For non-derivations argument, the argument itself is
 printed.)</para>
 
-<para>If the <option>--dry-run</option> option is used, then
-<command>nix-store</command> will print on standard error a
-description of what packages would be built or downloaded, and then
-quit.</para>
+<para>The following flags are available:</para>
+
+<variablelist>
+
+  <varlistentry><term><option>--dry-run</option></term>
+
+    <listitem><para>Print on standard error a description of what
+    packages would be built or downloaded, without actually performing
+    the operation</para></listitem>
+
+  </varlistentry>
+
+</variablelist>
 
 </refsection>
             
diff --git a/doc/manual/opt-common.xml b/doc/manual/opt-common.xml
index 0b57517670be..72971bd6a7d5 100644
--- a/doc/manual/opt-common.xml
+++ b/doc/manual/opt-common.xml
@@ -361,6 +361,17 @@
 </varlistentry>
 
 
+<varlistentry><term><option>--repair</option></term>
+
+  <listitem><para>Fix corrupted or missing store paths by
+  redownloading or rebuilding them.  Note that this is slow because it
+  requires computing a cryptographic hash of the contents of every
+  path in the closure of the build.  Also note the warning under
+  <command>nix-store --repair-path</command>.</para></listitem>
+
+</varlistentry>
+
+
 </variablelist>
 
 
diff --git a/doc/manual/release-notes.xml b/doc/manual/release-notes.xml
index af196344c455..43d5080afabd 100644
--- a/doc/manual/release-notes.xml
+++ b/doc/manual/release-notes.xml
@@ -21,8 +21,14 @@
 
   <listitem>
     <para>The new operation <command>nix-store --repair-path</command>
-    allows corrupted or deleted store paths to be repaired by
-    redownloading them.</para>
+    allows corrupted or missing store paths to be repaired by
+    redownloading them.  <command>nix-store --verify --check-contents
+    --repair</command> will scan and repair all paths in the Nix
+    store.  Similarly, <command>nix-env</command>,
+    <command>nix-build</command>, <command>nix-instantiate</command>
+    and <command>nix-store --realise</command> have a
+    <option>--repair</option> flag to detect and fix bad paths by
+    rebuilding or redownloading them.</para>
   </listitem>
 
   <listitem>