about summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorEelco Dolstra <eelco.dolstra@logicblox.com>2012-10-23T16·04+0200
committerEelco Dolstra <eelco.dolstra@logicblox.com>2012-10-23T16·04+0200
commita28b4445a4eb8108dfc028083d3939d5f3a42685 (patch)
treebbf989d956ab6b3ea2830d75c79d5adc69c7664f /doc
parent2980d1fba97069805c3649c5d99d0356bce6c303 (diff)
nix-prefetch-url: Improve option handling
Diffstat (limited to 'doc')
-rw-r--r--doc/manual/nix-hash.xml5
-rw-r--r--doc/manual/nix-prefetch-url.xml24
2 files changed, 22 insertions, 7 deletions
diff --git a/doc/manual/nix-hash.xml b/doc/manual/nix-hash.xml
index 007fc5410037..af4e361ff8d4 100644
--- a/doc/manual/nix-hash.xml
+++ b/doc/manual/nix-hash.xml
@@ -91,8 +91,9 @@ cryptographic hash as <literal>nix-store --dump
 
   <varlistentry><term><option>--type</option> <replaceable>hashAlgo</replaceable></term>
 
-    <listitem><para>Specify a cryptographic hash, which can be one of
-    <literal>md5</literal>, <literal>sha1</literal>, and
+    <listitem><para>Use the specified cryptographic hash algorithm,
+    which can be one of <literal>md5</literal>,
+    <literal>sha1</literal>, and
     <literal>sha256</literal>.</para></listitem>
 
   </varlistentry>
diff --git a/doc/manual/nix-prefetch-url.xml b/doc/manual/nix-prefetch-url.xml
index 0d953e9467bc..c416e675b05c 100644
--- a/doc/manual/nix-prefetch-url.xml
+++ b/doc/manual/nix-prefetch-url.xml
@@ -18,6 +18,7 @@
 <refsynopsisdiv>
   <cmdsynopsis>
     <command>nix-prefetch-url</command>
+    <arg><option>--type</option> <replaceable>hashAlgo</replaceable></arg>
     <arg choice='plain'><replaceable>url</replaceable></arg>
     <arg><replaceable>hash</replaceable></arg>
   </cmdsynopsis>
@@ -45,11 +46,6 @@ download it again when you build your Nix expression.  Since
 as <command>nix-prefetch-url</command>, the redundant download can be
 avoided.</para>
 
-<para>The environment variable <envar>NIX_HASH_ALGO</envar> specifies
-which hash algorithm to use.  It can be either <literal>md5</literal>,
-<literal>sha1</literal>, or <literal>sha256</literal>.  The default is
-<literal>sha256</literal>.</para>
-
 <para>If <replaceable>hash</replaceable> is specified, then a download
 is not performed if the Nix store already contains a file with the
 same hash and base name.  Otherwise, the file is downloaded, and an
@@ -63,6 +59,24 @@ of the downloaded file in the Nix store is also printed.</para>
 </refsection>
 
 
+<refsection><title>Options</title>
+
+<variablelist>
+  
+  <varlistentry><term><option>--type</option> <replaceable>hashAlgo</replaceable></term>
+
+    <listitem><para>Use the specified cryptographic hash algorithm,
+    which can be one of <literal>md5</literal>,
+    <literal>sha1</literal>, and
+    <literal>sha256</literal>.</para></listitem>
+
+  </varlistentry>
+
+</variablelist>
+
+</refsection>
+
+
 <refsection><title>Examples</title>
 
 <screen>