mirror of
https://github.com/NixOS/nix.git
synced 2025-11-15 15:02:42 +01:00
Merge pull request #14545 from NixOS/fetchTree-sort
Sort the `builtins.fetchTree` doc's lists
This commit is contained in:
commit
3645671570
1 changed files with 66 additions and 66 deletions
|
|
@ -317,77 +317,11 @@ static RegisterPrimOp primop_fetchTree({
|
||||||
> }
|
> }
|
||||||
> ```
|
> ```
|
||||||
|
|
||||||
- `"tarball"`
|
|
||||||
|
|
||||||
Download a tar archive and extract it into the Nix store.
|
|
||||||
This has the same underlying implementation as [`builtins.fetchTarball`](@docroot@/language/builtins.md#builtins-fetchTarball)
|
|
||||||
|
|
||||||
- `url` (String, required)
|
|
||||||
|
|
||||||
> **Example**
|
|
||||||
>
|
|
||||||
> ```nix
|
|
||||||
> fetchTree {
|
|
||||||
> type = "tarball";
|
|
||||||
> url = "https://github.com/NixOS/nixpkgs/tarball/nixpkgs-23.11";
|
|
||||||
> }
|
|
||||||
> ```
|
|
||||||
|
|
||||||
- `"git"`
|
- `"git"`
|
||||||
|
|
||||||
Fetch a Git tree and copy it to the Nix store.
|
Fetch a Git tree and copy it to the Nix store.
|
||||||
This is similar to [`builtins.fetchGit`](@docroot@/language/builtins.md#builtins-fetchGit).
|
This is similar to [`builtins.fetchGit`](@docroot@/language/builtins.md#builtins-fetchGit).
|
||||||
|
|
||||||
- `url` (String, required)
|
|
||||||
|
|
||||||
The URL formats supported are the same as for Git itself.
|
|
||||||
|
|
||||||
> **Example**
|
|
||||||
>
|
|
||||||
> ```nix
|
|
||||||
> fetchTree {
|
|
||||||
> type = "git";
|
|
||||||
> url = "git@github.com:NixOS/nixpkgs.git";
|
|
||||||
> }
|
|
||||||
> ```
|
|
||||||
|
|
||||||
> **Note**
|
|
||||||
>
|
|
||||||
> If the URL points to a local directory, and no `ref` or `rev` is given, Nix only considers files added to the Git index, as listed by `git ls-files` but use the *current file contents* of the Git working directory.
|
|
||||||
|
|
||||||
- `ref` (String, optional)
|
|
||||||
|
|
||||||
By default, this has no effect. This becomes relevant only once `shallow` cloning is disabled.
|
|
||||||
|
|
||||||
A [Git reference](https://git-scm.com/book/en/v2/Git-Internals-Git-References), such as a branch or tag name.
|
|
||||||
|
|
||||||
Default: `"HEAD"`
|
|
||||||
|
|
||||||
- `rev` (String, optional)
|
|
||||||
|
|
||||||
A Git revision; a commit hash.
|
|
||||||
|
|
||||||
Default: the tip of `ref`
|
|
||||||
|
|
||||||
- `shallow` (Bool, optional)
|
|
||||||
|
|
||||||
Make a shallow clone when fetching the Git tree.
|
|
||||||
When this is enabled, the options `ref` and `allRefs` have no effect anymore.
|
|
||||||
|
|
||||||
Default: `true`
|
|
||||||
|
|
||||||
- `submodules` (Bool, optional)
|
|
||||||
|
|
||||||
Also fetch submodules if available.
|
|
||||||
|
|
||||||
Default: `false`
|
|
||||||
|
|
||||||
- `lfs` (Bool, optional)
|
|
||||||
|
|
||||||
Fetch any [Git LFS](https://git-lfs.com/) files.
|
|
||||||
|
|
||||||
Default: `false`
|
|
||||||
|
|
||||||
- `allRefs` (Bool, optional)
|
- `allRefs` (Bool, optional)
|
||||||
|
|
||||||
By default, this has no effect. This becomes relevant only once `shallow` cloning is disabled.
|
By default, this has no effect. This becomes relevant only once `shallow` cloning is disabled.
|
||||||
|
|
@ -405,6 +339,26 @@ static RegisterPrimOp primop_fetchTree({
|
||||||
If set, pass through the value to the output attribute set.
|
If set, pass through the value to the output attribute set.
|
||||||
Otherwise, generated from the fetched Git tree.
|
Otherwise, generated from the fetched Git tree.
|
||||||
|
|
||||||
|
- `lfs` (Bool, optional)
|
||||||
|
|
||||||
|
Fetch any [Git LFS](https://git-lfs.com/) files.
|
||||||
|
|
||||||
|
Default: `false`
|
||||||
|
|
||||||
|
- `ref` (String, optional)
|
||||||
|
|
||||||
|
By default, this has no effect. This becomes relevant only once `shallow` cloning is disabled.
|
||||||
|
|
||||||
|
A [Git reference](https://git-scm.com/book/en/v2/Git-Internals-Git-References), such as a branch or tag name.
|
||||||
|
|
||||||
|
Default: `"HEAD"`
|
||||||
|
|
||||||
|
- `rev` (String, optional)
|
||||||
|
|
||||||
|
A Git revision; a commit hash.
|
||||||
|
|
||||||
|
Default: the tip of `ref`
|
||||||
|
|
||||||
- `revCount` (Integer, optional)
|
- `revCount` (Integer, optional)
|
||||||
|
|
||||||
Number of revisions in the history of the Git repository before the fetched commit.
|
Number of revisions in the history of the Git repository before the fetched commit.
|
||||||
|
|
@ -412,6 +366,52 @@ static RegisterPrimOp primop_fetchTree({
|
||||||
If set, pass through the value to the output attribute set.
|
If set, pass through the value to the output attribute set.
|
||||||
Otherwise, generated from the fetched Git tree.
|
Otherwise, generated from the fetched Git tree.
|
||||||
|
|
||||||
|
- `shallow` (Bool, optional)
|
||||||
|
|
||||||
|
Make a shallow clone when fetching the Git tree.
|
||||||
|
When this is enabled, the options `ref` and `allRefs` have no effect anymore.
|
||||||
|
|
||||||
|
Default: `true`
|
||||||
|
|
||||||
|
- `submodules` (Bool, optional)
|
||||||
|
|
||||||
|
Also fetch submodules if available.
|
||||||
|
|
||||||
|
Default: `false`
|
||||||
|
|
||||||
|
- `url` (String, required)
|
||||||
|
|
||||||
|
The URL formats supported are the same as for Git itself.
|
||||||
|
|
||||||
|
> **Example**
|
||||||
|
>
|
||||||
|
> ```nix
|
||||||
|
> fetchTree {
|
||||||
|
> type = "git";
|
||||||
|
> url = "git@github.com:NixOS/nixpkgs.git";
|
||||||
|
> }
|
||||||
|
> ```
|
||||||
|
|
||||||
|
> **Note**
|
||||||
|
>
|
||||||
|
> If the URL points to a local directory, and no `ref` or `rev` is given, Nix only considers files added to the Git index, as listed by `git ls-files` but use the *current file contents* of the Git working directory.
|
||||||
|
|
||||||
|
- `"tarball"`
|
||||||
|
|
||||||
|
Download a tar archive and extract it into the Nix store.
|
||||||
|
This has the same underlying implementation as [`builtins.fetchTarball`](@docroot@/language/builtins.md#builtins-fetchTarball)
|
||||||
|
|
||||||
|
- `url` (String, required)
|
||||||
|
|
||||||
|
> **Example**
|
||||||
|
>
|
||||||
|
> ```nix
|
||||||
|
> fetchTree {
|
||||||
|
> type = "tarball";
|
||||||
|
> url = "https://github.com/NixOS/nixpkgs/tarball/nixpkgs-23.11";
|
||||||
|
> }
|
||||||
|
> ```
|
||||||
|
|
||||||
The following input types are still subject to change:
|
The following input types are still subject to change:
|
||||||
|
|
||||||
- `"path"`
|
- `"path"`
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue