From 2b2de5ef6aeb023f22e551e74e454acc73106cc8 Mon Sep 17 00:00:00 2001
From: Frederik Rietdijk <freddyrietdijk@fridh.nl>
Date: Thu, 11 May 2017 13:38:13 +0200
Subject: Document fetchTarball can take a sha256

Note that I refer to `nix-prefetch-url`.
---
 doc/manual/expressions/builtins.xml | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

(limited to 'doc/manual/expressions/builtins.xml')

diff --git a/doc/manual/expressions/builtins.xml b/doc/manual/expressions/builtins.xml
index 63d13e184a12..e9c641ab305a 100644
--- a/doc/manual/expressions/builtins.xml
+++ b/doc/manual/expressions/builtins.xml
@@ -292,6 +292,24 @@ with import (fetchTarball https://github.com/NixOS/nixpkgs-channels/archive/nixo
 stdenv.mkDerivation { … }
 </programlisting>
 
+    Note that when obtaining the hash with <varname>nix-prefetch-url
+    </varname> the option <varname>--unpack</varname> is required.
+    </para> 
+      
+    <para>This function can also verify the contents against a hash. 
+    In that case, the function takes a set instead of a URL. The set 
+    requires the attribute <varname>url</varname> and the attribute
+    <varname>sha256</varname>, e.g.
+      
+<programlisting>
+with import (fetchTarball {
+  url = https://github.com/NixOS/nixpkgs-channels/archive/nixos-14.12.tar.gz;
+  sha256 = "1jppksrfvbk5ypiqdz4cddxdl8z6zyzdb2srq8fcffr327ld5jj2";
+}) {};
+
+stdenv.mkDerivation { … }
+</programlisting>
+      
     </para>
 
     <para>This function is not available if <link
-- 
cgit 1.4.1