summaryrefslogtreecommitdiffstats
path: root/Documentation/fetch-options.txt
diff options
context:
space:
mode:
authorElijah Newren <newren@gmail.com>2024-11-04 20:02:44 +0100
committerJunio C Hamano <gitster@pobox.com>2024-11-05 07:53:23 +0100
commit00e10e075100a1c84549c4463a05837f215d91c0 (patch)
tree4c9a86fa9f9bdc4b93081a4a2d4c3baf6972df5b /Documentation/fetch-options.txt
parentupload-pack: fix ambiguous error message (diff)
downloadgit-00e10e075100a1c84549c4463a05837f215d91c0.tar.xz
git-00e10e075100a1c84549c4463a05837f215d91c0.zip
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/fetch-options.txt')
-rw-r--r--Documentation/fetch-options.txt2
1 files changed, 1 insertions, 1 deletions
diff --git a/Documentation/fetch-options.txt b/Documentation/fetch-options.txt
index 9dc7ac8dbd..b01372e4b3 100644
--- a/Documentation/fetch-options.txt
+++ b/Documentation/fetch-options.txt
@@ -29,7 +29,7 @@
Deepen or shorten the history of a shallow repository to
include all reachable commits after <date>.
---shallow-exclude=<revision>::
+--shallow-exclude=<ref>::
Deepen or shorten the history of a shallow repository to
exclude commits reachable from a specified remote branch or tag.
This option can be specified multiple times.