From c8205a3413217ccf8a6a1f7e064b06a5b86c3253 Mon Sep 17 00:00:00 2001
From: Graham Christensen <graham@grahamc.com>
Date: Tue, 2 Jul 2019 09:04:04 -0400
Subject: builtins.fetchGit: document absolute ref support

---
 doc/manual/expressions/builtins.xml | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

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

diff --git a/doc/manual/expressions/builtins.xml b/doc/manual/expressions/builtins.xml
index 412622714d40..dcd7aaf243ce 100644
--- a/doc/manual/expressions/builtins.xml
+++ b/doc/manual/expressions/builtins.xml
@@ -419,6 +419,13 @@ stdenv.mkDerivation { … }
               This is often a branch or tag name. Defaults to
               <literal>HEAD</literal>.
             </para>
+
+            <para>
+              By default, the <varname>ref</varname> value is prefixed
+              with <literal>refs/heads/</literal>. As of Nix 2.3.0
+              Nix will not prefix <literal>refs/heads/</literal> if
+              <varname>ref</varname> starts with <literal>refs/</literal>.
+            </para>
           </listitem>
         </varlistentry>
       </variablelist>
@@ -432,6 +439,14 @@ stdenv.mkDerivation { … }
 }</programlisting>
       </example>
 
+      <example>
+        <title>Fetching an arbitrary ref</title>
+        <programlisting>builtins.fetchGit {
+  url = "https://gitub.com/NixOS/nix.git";
+  ref = "refs/heads/0.5-release";
+}</programlisting>
+      </example>
+
       <example>
         <title>Fetching a repository's specific commit on an arbitrary branch</title>
         <para>
-- 
cgit 1.4.1