philiptaron/lix
0
0
Fork 0
forked from lix-project/lix
Code Pull requests Activity

builtins.fetchGit: document absolute ref support

Browse source
This commit is contained in:
Graham Christensen 2019-07-02 09:04:04 -04:00
parent 7e35e914c1
commit c8205a3413
No known key found for this signature in database
GPG key ID: ACA1C1D120C83D5C
3 changed files with 38 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
doc/manual/expressions/builtins.xml
View file

@ -419,6 +419,13 @@ stdenv.mkDerivation { … }
This is often a branch or tag name. Defaults to This is often a branch or tag name. Defaults to
<literal>HEAD</literal>. <literal>HEAD</literal>.
</para> </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> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
@ -432,6 +439,14 @@ stdenv.mkDerivation { … }
}</programlisting> }</programlisting>
</example> </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> <example>
<title>Fetching a repository's specific commit on an arbitrary branch</title> <title>Fetching a repository's specific commit on an arbitrary branch</title>
<para> <para>

1
doc/manual/release-notes/release-notes.xml
View file

@ -12,6 +12,7 @@
</partintro> </partintro>
--> -->
<xi:include href="rl-2.3.xml" />
<xi:include href="rl-2.2.xml" /> <xi:include href="rl-2.2.xml" />
<xi:include href="rl-2.1.xml" /> <xi:include href="rl-2.1.xml" />
<xi:include href="rl-2.0.xml" /> <xi:include href="rl-2.0.xml" />

22
doc/manual/release-notes/rl-2.3.xml Normal file
View file

@ -0,0 +1,22 @@
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
version="5.0"
xml:id="ssec-relnotes-2.3">
<title>Release 2.3 (????-??-??)</title>
<para>This release contains the following changes:</para>
<itemizedlist>
<listitem>
<para><function>builtins.fetchGit</function>'s <varname>ref</varname>
argument now allows specifying an absolute remote ref.
Nix will automatically prefix <varname>ref</varname> with
<literal>refs/heads</literal> only if <varname>ref</varname> doesn't
already begin with <literal>refs/</literal>.
</para>
</listitem>
</itemizedlist>
</section>