about summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/stdenv.xml30
1 files changed, 13 insertions, 17 deletions
diff --git a/doc/stdenv.xml b/doc/stdenv.xml
index 99c5d30c2db9..b075e0219a54 100644
--- a/doc/stdenv.xml
+++ b/doc/stdenv.xml
@@ -1191,35 +1191,31 @@ echo @foo@
     <replaceable>file</replaceable>.</para></listitem>
   </varlistentry>
 
-  <varlistentry xml:id='fun-baseHash'>
-    <term>
-      <function>baseHash</function>
-      <replaceable>path</replaceable>
-      <replaceable>suffix</replaceable>
-    </term>
+
+  <varlistentry xml:id='fun-stripHash'>
+    <term><function>stripHash</function>
+    <replaceable>path</replaceable></term>
     <listitem><para>Strips the directory and hash part of a store
     path, storing the name part in the environment variable
-    <literal>strippedName</literal>. If <literal>suffix</literal> is also
-    provided, the suffix will also be removed. For example:</para>
+    <literal>strippedName</literal>. For example:
     
 <programlisting>
-baseHash "/nix/store/9s9r019176g7cvn2nvcw41gsp862y6b4-coreutils-8.24"
+stripHash "/nix/store/9s9r019176g7cvn2nvcw41gsp862y6b4-coreutils-8.24"
 # prints coreutils-8.24
+echo $strippedName
 </programlisting>
 
+    If you wish to store the result in another variable, then the
+    following idiom may be useful:
+    
 <programlisting>
-baseHash "/nix/store/0016702zbydafsr20n9l1dcw7x2bf6jj-arraysugar-0.1.0.gem" .gem
-# prints arraysugar-0.1.0
+name="/nix/store/9s9r019176g7cvn2nvcw41gsp862y6b4-coreutils-8.24"
+someVar=$(stripHash $name; echo $strippedName)
 </programlisting>
-    </listitem>
 
+    </para></listitem>
   </varlistentry>
 
-  <varlistentry xml:id='fun-stripHash'>
-    <term><function>stripHash</function>
-    <replaceable>path</replaceable></term>
-    <listitem><para>Deprecated. Use baseHash instead.</para></listitem>
-  </varlistentry>
   
 </variablelist>