From 55f59a63a9dd2309779e06af797719984f185523 Mon Sep 17 00:00:00 2001 From: Jasi Date: Sat, 4 Oct 2025 15:58:21 -0400 Subject: [PATCH] doc/fetchers: expand `fetchFromBitbucket` docs The approach used to expand the documentation for `fetchFromBitbucket` purposefully mimics the documentation for `fetchFromGitHub` with the goal of making sure the reader is aware of all of the fetcher's capabilities without having to read the source code. --- doc/build-helpers/fetchers.chapter.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/doc/build-helpers/fetchers.chapter.md b/doc/build-helpers/fetchers.chapter.md index c665a5fa8436..62c38ec4c59e 100644 --- a/doc/build-helpers/fetchers.chapter.md +++ b/doc/build-helpers/fetchers.chapter.md @@ -882,7 +882,17 @@ This is used with Gitiles repositories. The arguments expected are similar to `f ## `fetchFromBitbucket` {#fetchfrombitbucket} -This is used with BitBucket repositories. The arguments expected are very similar to `fetchFromGitHub` above. +Used for repositories hosted on Bitbucket (`"bitbucket.org"`) owned by the Australian-based Atlassian Corporation. It requires an `owner` and `repo` argument which are both strings that reference the workspace ID and repository name hosted on Bitbucket cloud as well as either a `tag` or `rev` argument. + +By default, `fetchFromBitbucket` will attempt to download a commit snapshot tarball at the specified `tag` or `rev` at `https://bitbucket.org///get/.tar.gz` + +However, `fetchFromBitbucket` will automatically switch to using `fetchgit` and fetch from `https://bitbucket.org//.git` in any of these cases: + +- `forceFetchGit`, `leaveDotGit`, `deepClone`, `fetchLFS`, or `fetchSubmodules` are set to `true` +- `sparseCheckout` contains any entries (is a non-empty list) +- `rootDir` is set to a non-empty string + +When `fetchgit` is used, refer to the `fetchgit` section for documentation of its available options. ## `fetchFromSavannah` {#fetchfromsavannah}