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 a460ea4a3c
(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>
maint
parent
5a875ff7fb
commit
00e10e0751
|
@ -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.
|
||||
|
|
|
@ -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.
|
||||
|
|
|
@ -91,7 +91,7 @@ be in a separate packet, and the list must end with a flush packet.
|
|||
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.
|
||||
|
|
|
@ -147,8 +147,8 @@ static struct option builtin_clone_options[] = {
|
|||
N_("create a shallow clone of that depth")),
|
||||
OPT_STRING(0, "shallow-since", &option_since, N_("time"),
|
||||
N_("create a shallow clone since a specific time")),
|
||||
OPT_STRING_LIST(0, "shallow-exclude", &option_not, N_("revision"),
|
||||
N_("deepen history of shallow clone, excluding rev")),
|
||||
OPT_STRING_LIST(0, "shallow-exclude", &option_not, N_("ref"),
|
||||
N_("deepen history of shallow clone, excluding ref")),
|
||||
OPT_BOOL(0, "single-branch", &option_single_branch,
|
||||
N_("clone only one branch, HEAD or --branch")),
|
||||
OPT_BOOL(0, "no-tags", &option_no_tags,
|
||||
|
|
|
@ -2216,8 +2216,8 @@ int cmd_fetch(int argc,
|
|||
N_("deepen history of shallow clone")),
|
||||
OPT_STRING(0, "shallow-since", &deepen_since, N_("time"),
|
||||
N_("deepen history of shallow repository based on time")),
|
||||
OPT_STRING_LIST(0, "shallow-exclude", &deepen_not, N_("revision"),
|
||||
N_("deepen history of shallow clone, excluding rev")),
|
||||
OPT_STRING_LIST(0, "shallow-exclude", &deepen_not, N_("ref"),
|
||||
N_("deepen history of shallow clone, excluding ref")),
|
||||
OPT_INTEGER(0, "deepen", &deepen_relative,
|
||||
N_("deepen history of shallow clone")),
|
||||
OPT_SET_INT_F(0, "unshallow", &unshallow,
|
||||
|
|
|
@ -218,8 +218,8 @@ static struct option pull_options[] = {
|
|||
OPT_PASSTHRU_ARGV(0, "shallow-since", &opt_fetch, N_("time"),
|
||||
N_("deepen history of shallow repository based on time"),
|
||||
0),
|
||||
OPT_PASSTHRU_ARGV(0, "shallow-exclude", &opt_fetch, N_("revision"),
|
||||
N_("deepen history of shallow clone, excluding rev"),
|
||||
OPT_PASSTHRU_ARGV(0, "shallow-exclude", &opt_fetch, N_("ref"),
|
||||
N_("deepen history of shallow clone, excluding ref"),
|
||||
0),
|
||||
OPT_PASSTHRU_ARGV(0, "deepen", &opt_fetch, N_("n"),
|
||||
N_("deepen history of shallow clone"),
|
||||
|
|
Loading…
Reference in New Issue