Merge pull request #7975 from fricklerhandwerk/fix-fetchgit

remove indentation in `fetchGit` attribute listing
This commit is contained in:
Eelco Dolstra 2023-03-06 11:00:40 +01:00 committed by GitHub
commit 92771ca1be
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -353,36 +353,44 @@ static RegisterPrimOp primop_fetchGit({
of the repo at that URL is fetched. Otherwise, it can be an
attribute with the following attributes (all except `url` optional):
- url\
The URL of the repo.
- `url`
- name\
The name of the directory the repo should be exported to in the
store. Defaults to the basename of the URL.
The URL of the repo.
- rev\
The git revision to fetch. Defaults to the tip of `ref`.
- `name` (default: *basename of the URL*)
- ref\
The git ref to look for the requested revision under. This is
often a branch or tag name. Defaults to `HEAD`.
The name of the directory the repo should be exported to in the store.
By default, the `ref` value is prefixed with `refs/heads/`. As
of Nix 2.3.0 Nix will not prefix `refs/heads/` if `ref` starts
with `refs/`.
- `rev` (default: *the tip of `ref`*)
- submodules\
A Boolean parameter that specifies whether submodules should be
checked out. Defaults to `false`.
The [Git revision] to fetch.
This is typically a commit hash.
- shallow\
A Boolean parameter that specifies whether fetching a shallow clone
is allowed. Defaults to `false`.
[Git revision]: https://git-scm.com/docs/git-rev-parse#_specifying_revisions
- allRefs\
Whether to fetch all refs of the repository. With this argument being
true, it's possible to load a `rev` from *any* `ref` (by default only
`rev`s from the specified `ref` are supported).
- `ref` (default: `HEAD`)
The [Git reference] under which to look for the requested revision.
This is often a branch or tag name.
[Git reference]: https://git-scm.com/book/en/v2/Git-Internals-Git-References
By default, the `ref` value is prefixed with `refs/heads/`.
As of 2.3.0, Nix will not prefix `refs/heads/` if `ref` starts with `refs/`.
- `submodules` (default: `false`)
A Boolean parameter that specifies whether submodules should be checked out.
- `shallow` (default: `false`)
A Boolean parameter that specifies whether fetching a shallow clone is allowed.
- `allRefs`
Whether to fetch all references of the repository.
With this argument being true, it's possible to load a `rev` from *any* `ref`
(by default only `rev`s from the specified `ref` are supported).
Here are some examples of how to use `fetchGit`.