]> git.ipfire.org Git - thirdparty/git.git/commit
doc: correct misleading descriptions for --shallow-exclude
authorElijah Newren <newren@gmail.com>
Mon, 4 Nov 2024 19:02:44 +0000 (19:02 +0000)
committerJunio C Hamano <gitster@pobox.com>
Tue, 5 Nov 2024 06:53:23 +0000 (22:53 -0800)
commit00e10e075100a1c84549c4463a05837f215d91c0
tree4c9a86fa9f9bdc4b93081a4a2d4c3baf6972df5b
parent5a875ff7fbd4b8edd99b339c7c9eaa0650b7b195
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>
Documentation/fetch-options.txt
Documentation/git-clone.txt
Documentation/git-fetch-pack.txt
builtin/clone.c
builtin/fetch.c
builtin/pull.c