summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorNguyễn Gia Phong <mcsinyx@disroot.org>2021-12-04 23:01:49 +0700
committerNguyễn Gia Phong <mcsinyx@disroot.org>2022-01-03 16:37:16 +0700
commitb97ccaa18d61b888b00513c0754745c27c36b293 (patch)
treeaa70c30cc3185ac6c73c88e261eb9e1a09a078bc /doc
parentce789257bbe1cf605af5cc628f8f0db9e662e72a (diff)
downloadnixpkgs-b97ccaa18d61b888b00513c0754745c27c36b293.tar
nixpkgs-b97ccaa18d61b888b00513c0754745c27c36b293.tar.gz
nixpkgs-b97ccaa18d61b888b00513c0754745c27c36b293.tar.bz2
nixpkgs-b97ccaa18d61b888b00513c0754745c27c36b293.tar.lz
nixpkgs-b97ccaa18d61b888b00513c0754745c27c36b293.tar.xz
nixpkgs-b97ccaa18d61b888b00513c0754745c27c36b293.tar.zst
nixpkgs-b97ccaa18d61b888b00513c0754745c27c36b293.zip
fetchFromSourcehut: allow recursive fetching
Diffstat (limited to 'doc')
-rw-r--r--doc/builders/fetchers.chapter.md9
1 files changed, 8 insertions, 1 deletions
diff --git a/doc/builders/fetchers.chapter.md b/doc/builders/fetchers.chapter.md
index e36724f295f..5b28b2dcb39 100644
--- a/doc/builders/fetchers.chapter.md
+++ b/doc/builders/fetchers.chapter.md
@@ -82,4 +82,11 @@ This is used with repo.or.cz repositories. The arguments expected are very simil
 
 ## `fetchFromSourcehut` {#fetchfromsourcehut}
 
-This is used with sourcehut repositories. The arguments expected are very similar to fetchFromGitHub above. Don't forget the tilde (~) in front of the user name!
+This is used with sourcehut repositories. Similar to `fetchFromGitHub` above,
+it expects `owner`, `repo`, `rev` and `sha256`, but don't forget the tilde (~)
+in front of the username! Expected arguments also include `vc` ("git" (default)
+or "hg"), `domain` and `fetchSubmodules`.
+
+If `fetchSubmodules` is `true`, `fetchFromSourcehut` uses `fetchgit`
+or `fetchhg` with `fetchSubmodules` or `fetchSubrepos` set to `true`,
+respectively. Otherwise the fetcher uses `fetchzip`.