Skip to content

clone: accept DEPTH env var as fallback for --depth#2333

Open
h8d13 wants to merge 1 commit into
git:masterfrom
h8d13:depth-env
Open

clone: accept DEPTH env var as fallback for --depth#2333
h8d13 wants to merge 1 commit into
git:masterfrom
h8d13:depth-env

Conversation

@h8d13

@h8d13 h8d13 commented Jun 11, 2026

Copy link
Copy Markdown

cc: "Matt Hunter" [email protected]

@gitgitgadget-git

Copy link
Copy Markdown

Welcome to GitGitGadget

Hi @h8d13, and welcome to GitGitGadget, the GitHub App to send patch series to the Git mailing list from GitHub Pull Requests.

Please make sure that either:

  • Your Pull Request has a good description, if it consists of multiple commits, as it will be used as cover letter.
  • Your Pull Request description is empty, if it consists of a single commit, as the commit message should be descriptive enough by itself.

You can CC potential reviewers by adding a footer to the PR description with the following syntax:

CC: Revi Ewer <[email protected]>, Ill Takalook <[email protected]>

NOTE: DO NOT copy/paste your CC list from a previous GGG PR's description,
because it will result in a malformed CC list on the mailing list. See
example.

Also, it is a good idea to review the commit messages one last time, as the Git project expects them in a quite specific form:

  • the lines should not exceed 76 columns,
  • the first line should be like a header and typically start with a prefix like "tests:" or "revisions:" to state which subsystem the change is about, and
  • the commit messages' body should be describing the "why?" of the change.
  • Finally, the commit messages should end in a Signed-off-by: line matching the commits' author.

It is in general a good idea to await the automated test ("Checks") in this Pull Request before contributing the patches, e.g. to avoid trivial issues such as unportable code.

Contributing the patches

Before you can contribute the patches, your GitHub username needs to be added to the list of permitted users. Any already-permitted user can do that, by adding a comment to your PR of the form /allow. A good way to find other contributors is to locate recent pull requests where someone has been /allowed:

Both the person who commented /allow and the PR author are able to /allow you.

An alternative is the channel #git-devel on the Libera Chat IRC network:

<newcontributor> I've just created my first PR, could someone please /allow me? https://github.com/gitgitgadget/git/pull/12345
<veteran> newcontributor: it is done
<newcontributor> thanks!

Once on the list of permitted usernames, you can contribute the patches to the Git mailing list by adding a PR comment /submit.

If you want to see what email(s) would be sent for a /submit request, add a PR comment /preview to have the email(s) sent to you. You must have a public GitHub email address for this. Note that any reviewers CC'd via the list in the PR description will not actually be sent emails.

After you submit, GitGitGadget will respond with another comment that contains the link to the cover letter mail in the Git mailing list archive. Please make sure to monitor the discussion in that thread and to address comments and suggestions (while the comments and suggestions will be mirrored into the PR by GitGitGadget, you will still want to reply via mail).

If you do not want to subscribe to the Git mailing list just to be able to respond to a mail, you can download the mbox from the Git mailing list archive (click the (raw) link), then import it into your mail program. If you use GMail, you can do this via:

curl -g --user "<EMailAddress>:<Password>" \
    --url "imaps://imap.gmail.com/INBOX" -T /path/to/raw.txt

To iterate on your change, i.e. send a revised patch or patch series, you will first want to (force-)push to the same branch. You probably also want to modify your Pull Request description (or title). It is a good idea to summarize the revision by adding something like this to the cover letter (read: by editing the first comment on the PR, i.e. the PR description):

Changes since v1:
- Fixed a typo in the commit message (found by ...)
- Added a code comment to ... as suggested by ...
...

To send a new iteration, just add another PR comment with the contents: /submit.

Need help?

New contributors who want advice are encouraged to join [email protected], where volunteers who regularly contribute to Git are willing to answer newbie questions, give advice, or otherwise provide mentoring to interested contributors. You must join in order to post or view messages, but anyone can join.

You may also be able to find help in real time in the developer IRC channel, #git-devel on Libera Chat. Remember that IRC does not support offline messaging, so if you send someone a private message and log out, they cannot respond to you. The scrollback of #git-devel is archived, though.

@Mroik

Mroik commented Jun 13, 2026

Copy link
Copy Markdown
Contributor

/allow

@gitgitgadget-git

Copy link
Copy Markdown

User h8d13 is now allowed to use GitGitGadget.

WARNING: h8d13 has no public email address set on GitHub; GitGitGadget needs an email address to Cc: you on your contribution, so that you receive any feedback on the Git mailing list. Go to https://github.com/settings/profile to make your preferred email public to let GitGitGadget know which email address to use.

@h8d13

h8d13 commented Jun 13, 2026

Copy link
Copy Markdown
Author

/submit

@gitgitgadget-git

Copy link
Copy Markdown

Submitted as [email protected]

To fetch this version into FETCH_HEAD:

git fetch https://github.com/gitgitgadget/git/ pr-git-2333/h8d13/depth-env-v1

To fetch this version to local tag pr-git-2333/h8d13/depth-env-v1:

git fetch --no-tags https://github.com/gitgitgadget/git/ tag pr-git-2333/h8d13/depth-env-v1

Comment thread builtin/clone.c
@gitgitgadget-git

Copy link
Copy Markdown

"Matt Hunter" wrote on the Git mailing list (how to reply to this email):

On Fri Jun 12, 2026 at 9:39 PM EDT, h8d13 via GitGitGadget wrote:
> @@ -1022,6 +1022,12 @@ int cmd_clone(int argc,
>  		usage_msg_opt(_("You must specify a repository to clone."),
>  			builtin_clone_usage, builtin_clone_options);
>  
> +	if (!option_depth) {
> +		const char *env_depth = getenv("DEPTH");

Nearly all of the non-standard environment variables used by git start
with "GIT_".  "GIT_CLONE_DEPTH" may be a better choice.

> +		if (env_depth && *env_depth)
> +			option_depth = xstrdup(env_depth);

Following normal command-line option parsing, if --depth is given, then
option_depth points to the parsed string from cmd_clone's argv array
directly and is not freed.  Therefore, the string copy returned via
xstrdup also goes unfreed before it is lost.

One might argue this isn't very impactful, since we would expect the
process to exit after git-clone completes, but there are already several
explicit calls to free and related functions at the end of cmd_clone.
> +	}
> +
>  	if (option_depth || option_since || option_not.nr)
>  		deepen = 1;
>  	if (option_single_branch == -1)
>
> base-commit: 3e65291872de10c3f0bf05ea8c24187e7a71ebf0

@gitgitgadget-git

Copy link
Copy Markdown

User "Matt Hunter" <[email protected]> has been added to the cc: list.

@gitgitgadget-git

Copy link
Copy Markdown

There are issues in commit d4c3989:
chore(fb): rename env var.

  • Commit checks stopped - the message is too short
  • Commit not signed off

@davvid

davvid commented Jun 13, 2026

Copy link
Copy Markdown
Contributor

When renaming the var and adding tests, please squash those changes into the first commit and revise its message (which also mentions DEPTH) to account for the rename.

@gitgitgadget-git

Copy link
Copy Markdown

There are issues in commit 21f8b0e:
chore(fb): Message-ID: <[email protected]>

  • Prefixed commit message must be in lower case
  • Commit not signed off

When git clone is run by a tool the user does not control directly
(CI runners, package build scripts such as makepkg, or any wrapper
that spawns nested clones), there is no way to request a shallow
clone: --depth only exists as a command-line option on the process
that invokes git clone, and unlike url.*.insteadOf there is no
configuration key that could be injected via GIT_CONFIG_* to achieve
the same effect.

Teach git clone to read the environment variable when --depth is
not given on the command line. Since environment variables propagate
to child processes, exporting an env var once makes every nested clone
underneath shallow, which is useful in CI pipelines and recursive
build tools. An explicit --depth on the command line still takes
precedence, and the value goes through the existing validation, so a
non-positive DEPTH dies with the same error as a non-positive
--depth.

Edits: add t/ tests, doc line and leak fix from Matt / davvid feedback

Signed-off-by: h8d13 <[email protected]>
@h8d13

h8d13 commented Jun 13, 2026

Copy link
Copy Markdown
Author

@davvid did just that :) thanks again for the tips.

@h8d13

h8d13 commented Jun 13, 2026

Copy link
Copy Markdown
Author

One might argue this isn't very impactful, since we would expect the
process to exit after git-clone completes, but there are already several
explicit calls to free and related functions at the end of cmd_clone.

In PKGBUILD the common case is;

git clone --depth 1 <url> <dest>
cd dest
bash run.sh
# here run.sh has its own clone dependencies (perhaps even multiple)
# --depth 1 is now lost

Hopefully that explains better the need

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants