Skip to content

Commit 419d2f7

Browse files
committed
doc: git-pull: move <repository> and <refspec> params
From user feedback: - it's confusing that we use both <branch> and <refspec> to refer to the second argument - one user is not clear about what `refs/heads/*:refs/remotes/origin/*` is meant to be an example of ("is it like a path?") The DESCRIPTION section is also doing a lot right now: it's trying to describe both how the <repository> and <refspec> arguments work (which is pretty complex, as seen in the DEFAULT BEHAVIOUR section) as well as how `git pull` calls `git fetch` and merge/rebase/etc depending on the arguments. Handle this by moving the description of the <repository> and <refspec> arguments to the OPTIONS section, so that we can focus on the merge/rebase/etc behaviour in the DESCRIPTION section, and refer folks to the later sections for details. Use the term "upstream" instead of 'the "remote" and "merge" configuration for the current branch' since users are more likely to know what an "upstream" is. Signed-off-by: Julia Evans <[email protected]>
1 parent ca2559c commit 419d2f7

File tree

2 files changed

+22
-11
lines changed

2 files changed

+22
-11
lines changed

Documentation/git-pull.adoc

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -27,17 +27,6 @@ and then depending on configuration options or command line flags,
2727
will call either `git rebase` or `git merge` to reconcile diverging
2828
branches.
2929

30-
<repository> should be the name of a remote repository as
31-
passed to linkgit:git-fetch[1]. <refspec> can name an
32-
arbitrary remote ref (for example, the name of a tag) or even
33-
a collection of refs with corresponding remote-tracking branches
34-
(e.g., refs/heads/{asterisk}:refs/remotes/origin/{asterisk}),
35-
but usually it is the name of a branch in the remote repository.
36-
37-
Default values for <repository> and <branch> are read from the
38-
"remote" and "merge" configuration for the current branch
39-
as set by linkgit:git-branch[1] `--track`.
40-
4130
Assume the following history exists and the current branch is
4231
"`master`":
4332

@@ -77,6 +66,26 @@ pulling or stash them away with linkgit:git-stash[1].
7766
OPTIONS
7867
-------
7968

69+
<repository>::
70+
The "remote" repository to pull from. This can be either
71+
a URL (see the section <<URLS,GIT URLS>> below) or the name
72+
of a remote (see the section <<REMOTES,REMOTES>> below).
73+
+
74+
Defaults to the configured upstream for the current branch, or `origin`.
75+
See <<UPSTREAM-BRANCHES,UPSTREAM BRANCHES>> below for more on how to
76+
configure upstreams.
77+
78+
<refspec>::
79+
Which branch or other reference(s) to fetch and integrate into the
80+
current branch, for example `main` in `git pull origin main`.
81+
Defaults to the configured upstream for the current branch.
82+
+
83+
This can be a branch, tag, or other collection of reference(s).
84+
See <<fetch-refspec,<refspec>>> below under "Options related to
85+
fetching" for the full syntax, and
86+
<<DEFAULT-BEHAVIOUR,DEFAULT BEHAVIOUR>> below for how `git pull` uses
87+
this argument to determine which remote branch to integrate.
88+
8089
-q::
8190
--quiet::
8291
This is passed to both underlying git-fetch to squelch reporting of
@@ -145,6 +154,7 @@ include::urls-remotes.adoc[]
145154

146155
include::merge-strategies.adoc[]
147156

157+
[[DEFAULT-BEHAVIOUR]]
148158
DEFAULT BEHAVIOUR
149159
-----------------
150160

Documentation/pull-fetch-param.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ ifndef::git-pull[]
1111
(See linkgit:git-config[1]).
1212
endif::git-pull[]
1313

14+
[[fetch-refspec]]
1415
<refspec>::
1516
Specifies which refs to fetch and which local refs to update.
1617
When no <refspec>s appear on the command line, the refs to fetch

0 commit comments

Comments
 (0)