Skip to content

Commit

Permalink
Merge branch 'ja/fetch-doc' into maint
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
gitster committed Nov 16, 2009
2 parents 077f3d4 + 7c85d27 commit f411c43
Show file tree
Hide file tree
Showing 3 changed files with 76 additions and 67 deletions.
48 changes: 24 additions & 24 deletions Documentation/fetch-options.txt
Original file line number Diff line number Diff line change
@@ -1,25 +1,13 @@
ifndef::git-pull[]
-q::
--quiet::
Pass --quiet to git-fetch-pack and silence any other internally
used git commands.

-v::
--verbose::
Be verbose.
endif::git-pull[]

-a::
--append::
Append ref names and object names of fetched refs to the
existing contents of `.git/FETCH_HEAD`. Without this
option old data in `.git/FETCH_HEAD` will be overwritten.

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

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

-k::
--keep::
Keep downloaded pack.

ifdef::git-pull[]
--no-tags::
endif::git-pull[]
Expand All @@ -49,10 +41,6 @@ endif::git-pull[]
flag lets all tags and their associated objects be
downloaded.

-k::
--keep::
Keep downloaded pack.

-u::
--update-head-ok::
By default 'git-fetch' refuses to update the head which
Expand All @@ -62,7 +50,19 @@ endif::git-pull[]
implementing your own Porcelain you are not supposed to
use it.

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

ifndef::git-pull[]
-q::
--quiet::
Pass --quiet to git-fetch-pack and silence any other internally
used git commands.

-v::
--verbose::
Be verbose.
endif::git-pull[]
7 changes: 7 additions & 0 deletions Documentation/git-pull.txt
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@ Also note that options meant for 'git-pull' itself and underlying

OPTIONS
-------

Options related to merging
~~~~~~~~~~~~~~~~~~~~~~~~~~

include::merge-options.txt[]

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

Options related to fetching
~~~~~~~~~~~~~~~~~~~~~~~~~~~

include::fetch-options.txt[]

include::pull-fetch-param.txt[]
Expand Down
88 changes: 45 additions & 43 deletions Documentation/merge-options.txt
Original file line number Diff line number Diff line change
@@ -1,43 +1,42 @@
-q::
--quiet::
Operate quietly.

-v::
--verbose::
Be verbose.

--stat::
Show a diffstat at the end of the merge. The diffstat is also
controlled by the configuration option merge.stat.

-n::
--no-stat::
Do not show a diffstat at the end of the merge.
--commit::
--no-commit::
Perform the merge and commit the result. This option can
be used to override --no-commit.
+
With --no-commit perform the merge but pretend the merge
failed and do not autocommit, to give the user a chance to
inspect and further tweak the merge result before committing.

--summary::
--no-summary::
Synonyms to --stat and --no-stat; these are deprecated and will be
removed in the future.
--ff::
--no-ff::
Do not generate a merge commit if the merge resolved as
a fast-forward, only update the branch pointer. This is
the default behavior of git-merge.
+
With --no-ff Generate a merge commit even if the merge
resolved as a fast-forward.

--log::
--no-log::
In addition to branch names, populate the log message with
one-line descriptions from the actual commits that are being
merged.
+
With --no-log do not list one-line descriptions from the
actual commits being merged.

--no-log::
Do not list one-line descriptions from the actual commits being
merged.

--no-commit::
Perform the merge but pretend the merge failed and do
not autocommit, to give the user a chance to inspect and
further tweak the merge result before committing.

--commit::
Perform the merge and commit the result. This option can
be used to override --no-commit.
--stat::
-n::
--no-stat::
Show a diffstat at the end of the merge. The diffstat is also
controlled by the configuration option merge.stat.
+
With -n or --no-stat do not show a diffstat at the end of the
merge.

--squash::
--no-squash::
Produce the working tree and index state as if a real
merge happened (except for the merge information),
but do not actually make a commit or
Expand All @@ -46,19 +45,9 @@
commit. This allows you to create a single commit on
top of the current branch whose effect is the same as
merging another branch (or more in case of an octopus).

--no-squash::
Perform the merge and commit the result. This option can
be used to override --squash.

--no-ff::
Generate a merge commit even if the merge resolved as a
fast-forward.

--ff::
Do not generate a merge commit if the merge resolved as
a fast-forward, only update the branch pointer. This is
the default behavior of git-merge.
+
With --no-squash perform the merge and commit the result. This
option can be used to override --squash.

-s <strategy>::
--strategy=<strategy>::
Expand All @@ -67,3 +56,16 @@
If there is no `-s` option, a built-in list of strategies
is used instead ('git-merge-recursive' when merging a single
head, 'git-merge-octopus' otherwise).

--summary::
--no-summary::
Synonyms to --stat and --no-stat; these are deprecated and will be
removed in the future.

-q::
--quiet::
Operate quietly.

-v::
--verbose::
Be verbose.

0 comments on commit f411c43

Please sign in to comment.