summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorRenaud <c0bw3b@users.noreply.github.com>2022-01-06 22:55:23 +0100
committerGitHub <noreply@github.com>2022-01-06 22:55:23 +0100
commit952aa6f820ce6ec717425c54b5817c81aac279c5 (patch)
treeb14e4755c1bea0962f7415fe1be3e6836c9b58b4 /doc
parentea185c3f6d4e4d6f801479976f129070b93cdf6d (diff)
parentb97ccaa18d61b888b00513c0754745c27c36b293 (diff)
Merge pull request #148606 from McSinyx/fetch-srht-recurse
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 e36724f295f9c..5b28b2dcb398a 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`.