Merge branch 'jc/maint-pull-docfix' into maint
authorJunio C Hamano <gitster@pobox.com>
Wed, 5 Feb 2014 22:03:47 +0000 (14:03 -0800)
committerJunio C Hamano <gitster@pobox.com>
Wed, 5 Feb 2014 22:03:47 +0000 (14:03 -0800)
The documentation to "git pull" hinted there is an "-m" option
because it incorrectly shared the documentation with "git merge".

* jc/maint-pull-docfix:
Documentation: "git pull" does not have the "-m" option
Documentation: exclude irrelevant options from "git pull"

1  2 
Documentation/git-pull.txt
Documentation/merge-options.txt
index 6083aab87bd947c8528cbf347769b6621531b035,546f7b195ccbdf527824c1e7c288f423f012dabf..200eb22260069af7a9e2e248f0794a73e2cf4a9f
@@@ -3,7 -3,7 +3,7 @@@ git-pull(1
  
  NAME
  ----
 -git-pull - Fetch from and merge with another repository or a local branch
 +git-pull - Fetch from and integrate with another repository or a local branch
  
  
  SYNOPSIS
@@@ -42,8 -42,6 +42,8 @@@ Assume the following history exists an
          A---B---C master on origin
         /
      D---E---F---G master
 +      ^
 +      origin/master in your repository
  ------------
  
  Then "`git pull`" will fetch and replay the changes from the remote
@@@ -53,7 -51,7 +53,7 @@@ result in a new commit along with the n
  and a log message from the user describing the changes.
  
  ------------
 -        A---B---C remotes/origin/master
 +        A---B---C origin/master
         /         \
      D---E---F---G---H master
  ------------
@@@ -99,23 -97,17 +99,23 @@@ must be given before the options meant 
  Options related to merging
  ~~~~~~~~~~~~~~~~~~~~~~~~~~
  
- include::merge-options.txt[]
  :git-pull: 1
  
+ include::merge-options.txt[]
  -r::
 ---rebase::
 -      Rebase the current branch on top of the upstream branch after
 -      fetching.  If there is a remote-tracking branch corresponding to
 -      the upstream branch and the upstream branch was rebased since last
 -      fetched, the rebase uses that information to avoid rebasing
 -      non-local changes.
 +--rebase[=false|true|preserve]::
 +      When true, rebase the current branch on top of the upstream
 +      branch after fetching. If there is a remote-tracking branch
 +      corresponding to the upstream branch and the upstream branch
 +      was rebased since last fetched, the rebase uses that information
 +      to avoid rebasing non-local changes.
 ++
 +When preserve, also rebase the current branch on top of the upstream
 +branch, but pass `--preserve-merges` along to `git rebase` so that
 +locally created merge commits will not be flattened.
 ++
 +When false, merge the current branch into the upstream branch.
  +
  See `pull.rebase`, `branch.<name>.rebase` and `branch.autosetuprebase` in
  linkgit:git-config[1] if you want to make `git pull` always use
index afba8d4f3b2dcc952310c270daf26e01f8b30800,d462bcc4c31595a93834d58f2e462b91bc53bfdc..e1343155fad7b2709d2f3700ea3d5b4c4d1a7a89
@@@ -14,9 -14,12 +14,12 @@@ inspect and further tweak the merge res
        further edit the auto-generated merge message, so that the user
        can explain and justify the merge. The `--no-edit` option can be
        used to accept the auto-generated message (this is generally
-       discouraged). The `--edit` (or `-e`) option is still useful if you are
-       giving a draft message with the `-m` option from the command line
-       and want to edit it in the editor.
+       discouraged).
+ ifndef::git-pull[]
+ The `--edit` (or `-e`) option is still useful if you are
+ giving a draft message with the `-m` option from the command line
+ and want to edit it in the editor.
+ endif::git-pull[]
  +
  Older scripts may depend on the historical behaviour of not allowing the
  user to edit the merge log message. They will see an editor opened when
@@@ -85,11 -88,6 +88,11 @@@ option can be used to override --squash
        Pass merge strategy specific option through to the merge
        strategy.
  
 +--verify-signatures::
 +--no-verify-signatures::
 +      Verify that the commits being merged have good and trusted GPG signatures
 +      and abort the merge in case they do not.
 +
  --summary::
  --no-summary::
        Synonyms to --stat and --no-stat; these are deprecated and will be