Skip to content

Commit f411c43

Browse files
committed
Merge branch 'ja/fetch-doc' into maint
* ja/fetch-doc: Documentation/merge-options.txt: order options in alphabetical groups Documentation/git-pull.txt: Add subtitles above included option files Documentation/fetch-options.txt: order options alphabetically
2 parents 077f3d4 + 7c85d27 commit f411c43

File tree

3 files changed

+76
-67
lines changed

3 files changed

+76
-67
lines changed

Documentation/fetch-options.txt

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,13 @@
1-
ifndef::git-pull[]
2-
-q::
3-
--quiet::
4-
Pass --quiet to git-fetch-pack and silence any other internally
5-
used git commands.
6-
7-
-v::
8-
--verbose::
9-
Be verbose.
10-
endif::git-pull[]
11-
121
-a::
132
--append::
143
Append ref names and object names of fetched refs to the
154
existing contents of `.git/FETCH_HEAD`. Without this
165
option old data in `.git/FETCH_HEAD` will be overwritten.
176

18-
--upload-pack <upload-pack>::
19-
When given, and the repository to fetch from is handled
20-
by 'git-fetch-pack', '--exec=<upload-pack>' is passed to
21-
the command to specify non-default path for the command
22-
run on the other end.
7+
--depth=<depth>::
8+
Deepen the history of a 'shallow' repository created by
9+
`git clone` with `--depth=<depth>` option (see linkgit:git-clone[1])
10+
by the specified number of commits.
2311

2412
-f::
2513
--force::
@@ -29,6 +17,10 @@ endif::git-pull[]
2917
fetches is a descendant of `<lbranch>`. This option
3018
overrides that check.
3119

20+
-k::
21+
--keep::
22+
Keep downloaded pack.
23+
3224
ifdef::git-pull[]
3325
--no-tags::
3426
endif::git-pull[]
@@ -49,10 +41,6 @@ endif::git-pull[]
4941
flag lets all tags and their associated objects be
5042
downloaded.
5143

52-
-k::
53-
--keep::
54-
Keep downloaded pack.
55-
5644
-u::
5745
--update-head-ok::
5846
By default 'git-fetch' refuses to update the head which
@@ -62,7 +50,19 @@ endif::git-pull[]
6250
implementing your own Porcelain you are not supposed to
6351
use it.
6452

65-
--depth=<depth>::
66-
Deepen the history of a 'shallow' repository created by
67-
`git clone` with `--depth=<depth>` option (see linkgit:git-clone[1])
68-
by the specified number of commits.
53+
--upload-pack <upload-pack>::
54+
When given, and the repository to fetch from is handled
55+
by 'git-fetch-pack', '--exec=<upload-pack>' is passed to
56+
the command to specify non-default path for the command
57+
run on the other end.
58+
59+
ifndef::git-pull[]
60+
-q::
61+
--quiet::
62+
Pass --quiet to git-fetch-pack and silence any other internally
63+
used git commands.
64+
65+
-v::
66+
--verbose::
67+
Be verbose.
68+
endif::git-pull[]

Documentation/git-pull.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@ Also note that options meant for 'git-pull' itself and underlying
2626

2727
OPTIONS
2828
-------
29+
30+
Options related to merging
31+
~~~~~~~~~~~~~~~~~~~~~~~~~~
32+
2933
include::merge-options.txt[]
3034

3135
:git-pull: 1
@@ -47,6 +51,9 @@ unless you have read linkgit:git-rebase[1] carefully.
4751
--no-rebase::
4852
Override earlier --rebase.
4953

54+
Options related to fetching
55+
~~~~~~~~~~~~~~~~~~~~~~~~~~~
56+
5057
include::fetch-options.txt[]
5158

5259
include::pull-fetch-param.txt[]

Documentation/merge-options.txt

Lines changed: 45 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,42 @@
1-
-q::
2-
--quiet::
3-
Operate quietly.
4-
5-
-v::
6-
--verbose::
7-
Be verbose.
8-
9-
--stat::
10-
Show a diffstat at the end of the merge. The diffstat is also
11-
controlled by the configuration option merge.stat.
12-
13-
-n::
14-
--no-stat::
15-
Do not show a diffstat at the end of the merge.
1+
--commit::
2+
--no-commit::
3+
Perform the merge and commit the result. This option can
4+
be used to override --no-commit.
5+
+
6+
With --no-commit perform the merge but pretend the merge
7+
failed and do not autocommit, to give the user a chance to
8+
inspect and further tweak the merge result before committing.
169

17-
--summary::
18-
--no-summary::
19-
Synonyms to --stat and --no-stat; these are deprecated and will be
20-
removed in the future.
10+
--ff::
11+
--no-ff::
12+
Do not generate a merge commit if the merge resolved as
13+
a fast-forward, only update the branch pointer. This is
14+
the default behavior of git-merge.
15+
+
16+
With --no-ff Generate a merge commit even if the merge
17+
resolved as a fast-forward.
2118

2219
--log::
20+
--no-log::
2321
In addition to branch names, populate the log message with
2422
one-line descriptions from the actual commits that are being
2523
merged.
24+
+
25+
With --no-log do not list one-line descriptions from the
26+
actual commits being merged.
2627

27-
--no-log::
28-
Do not list one-line descriptions from the actual commits being
29-
merged.
30-
31-
--no-commit::
32-
Perform the merge but pretend the merge failed and do
33-
not autocommit, to give the user a chance to inspect and
34-
further tweak the merge result before committing.
3528

36-
--commit::
37-
Perform the merge and commit the result. This option can
38-
be used to override --no-commit.
29+
--stat::
30+
-n::
31+
--no-stat::
32+
Show a diffstat at the end of the merge. The diffstat is also
33+
controlled by the configuration option merge.stat.
34+
+
35+
With -n or --no-stat do not show a diffstat at the end of the
36+
merge.
3937

4038
--squash::
39+
--no-squash::
4140
Produce the working tree and index state as if a real
4241
merge happened (except for the merge information),
4342
but do not actually make a commit or
@@ -46,19 +45,9 @@
4645
commit. This allows you to create a single commit on
4746
top of the current branch whose effect is the same as
4847
merging another branch (or more in case of an octopus).
49-
50-
--no-squash::
51-
Perform the merge and commit the result. This option can
52-
be used to override --squash.
53-
54-
--no-ff::
55-
Generate a merge commit even if the merge resolved as a
56-
fast-forward.
57-
58-
--ff::
59-
Do not generate a merge commit if the merge resolved as
60-
a fast-forward, only update the branch pointer. This is
61-
the default behavior of git-merge.
48+
+
49+
With --no-squash perform the merge and commit the result. This
50+
option can be used to override --squash.
6251

6352
-s <strategy>::
6453
--strategy=<strategy>::
@@ -67,3 +56,16 @@
6756
If there is no `-s` option, a built-in list of strategies
6857
is used instead ('git-merge-recursive' when merging a single
6958
head, 'git-merge-octopus' otherwise).
59+
60+
--summary::
61+
--no-summary::
62+
Synonyms to --stat and --no-stat; these are deprecated and will be
63+
removed in the future.
64+
65+
-q::
66+
--quiet::
67+
Operate quietly.
68+
69+
-v::
70+
--verbose::
71+
Be verbose.

0 commit comments

Comments
 (0)