diff options
| author | Elijah Newren <newren@gmail.com> | 2024-11-04 19:02:44 +0000 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2024-11-04 22:53:23 -0800 |
| commit | 00e10e075100a1c84549c4463a05837f215d91c0 (patch) | |
| tree | 4c9a86fa9f9bdc4b93081a4a2d4c3baf6972df5b /Documentation/git-clone.txt | |
| parent | 5a875ff7fbd4b8edd99b339c7c9eaa0650b7b195 (diff) | |
| download | git-00e10e075100a1c84549c4463a05837f215d91c0.tar.xz | |
doc: correct misleading descriptions for --shallow-exclude
The documentation for the --shallow-exclude option to clone/fetch/etc.
claims that the option takes a revision, but it does not. As per
upload-pack.c's process_deepen_not(), it passes the option to
expand_ref() and dies if it does not find exactly one ref matching the
name passed. Further, this has always been the case ever since these
options were introduced by the commits merged in a460ea4a3cb1 (Merge
branch 'nd/shallow-deepen', 2016-10-10). Fix the documentation to
match the implementation.
Signed-off-by: Elijah Newren <newren@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-clone.txt')
| -rw-r--r-- | Documentation/git-clone.txt | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index 116ad64820..7acb4cb176 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -255,7 +255,7 @@ corresponding `--mirror` and `--no-tags` options instead. `--shallow-since=<date>`:: Create a shallow clone with a history after the specified time. -`--shallow-exclude=<revision>`:: +`--shallow-exclude=<ref>`:: Create a shallow clone with a history, excluding commits reachable from a specified remote branch or tag. This option can be specified multiple times. |