max/nix-super
1
0
Fork 0
mirror of https://github.com/privatevoid-net/nix-super.git synced 2024-11-25 23:36:16 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Document fetchGit.

Browse source 
Fixes #1981.
This commit is contained in:
Shea Levy 2018-03-22 19:12:11 -04:00
parent 2bc6cfe1ad
commit 6856fe62b0
No known key found for this signature in database
GPG key ID: 5C0BD6957D86FE27
1 changed files with 55 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -307,6 +307,61 @@ stdenv.mkDerivation { … }
</varlistentry>
<varlistentry>
<term>
<function>builtins.fetchGit</function>
<replaceable>args</replaceable>
</term>
<listitem>
<para>
Fetch a path from git. <replaceable>args</replaceable> can be
a URL, in which case the HEAD of the repo at that URL is
fetched. Otherwise, it can be an attribute with the following
attributes (all except <varname>url</varname> optional):
</para>
<variablelist>
<varlistentry>
<term>url</term>
<listitem>
<para>
The URL of the repo.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>name</term>
<listitem>
<para>
The name of the directory the repo should be exported to
in the store. Defaults to the basename of the URL.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>rev</term>
<listitem>
<para>
The git revision to fetch. Defaults to the tip of
<varname>ref</varname>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ref</term>
<listitem>
<para>
The git ref to look for the requested revision under.
This is often a branch or tag name. Defaults to
<literal>HEAD</literal>.
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry><term><function>builtins.filter</function>
<replaceable>f</replaceable> <replaceable>xs</replaceable></term>