Merge branch 'tz/branch-doc-remove-set-upstream'
authorJunio C Hamano <gitster@pobox.com>
Wed, 6 Dec 2017 17:23:36 +0000 (09:23 -0800)
committerJunio C Hamano <gitster@pobox.com>
Wed, 6 Dec 2017 17:23:36 +0000 (09:23 -0800)
"git branch --set-upstream" has been deprecated and (sort of)
removed, as "--set-upstream-to" is the preferred one these days.
The documentation still had "--set-upstream" listed on its
synopsys section, which has been corrected.

* tz/branch-doc-remove-set-upstream:
branch doc: remove --set-upstream from synopsis

1  2 
Documentation/git-branch.txt
index 520c53b5e8bd3792c349db1895fa2e5608ca0a08,de90fde378cf9500d1c230ca9f2caeebffac8c74..b3084c99c1cabdccc690e4cec5071b22774bf6c8
@@@ -14,11 -14,10 +14,11 @@@ SYNOPSI
        [(--merged | --no-merged) [<commit>]]
        [--contains [<commit]] [--no-contains [<commit>]]
        [--points-at <object>] [--format=<format>] [<pattern>...]
- 'git branch' [--set-upstream | --track | --no-track] [-l] [-f] <branchname> [<start-point>]
+ 'git branch' [--track | --no-track] [-l] [-f] <branchname> [<start-point>]
  'git branch' (--set-upstream-to=<upstream> | -u <upstream>) [<branchname>]
  'git branch' --unset-upstream [<branchname>]
  'git branch' (-m | -M) [<oldbranch>] <newbranch>
 +'git branch' (-c | -C) [<oldbranch>] <newbranch>
  'git branch' (-d | -D) [-r] <branchname>...
  'git branch' --edit-description [<branchname>]
  
@@@ -65,10 -64,6 +65,10 @@@ If <oldbranch> had a corresponding refl
  renaming. If <newbranch> exists, -M must be used to force the rename
  to happen.
  
 +The `-c` and `-C` options have the exact same semantics as `-m` and
 +`-M`, except instead of the branch being renamed it along with its
 +config and reflog will be copied to a new name.
 +
  With a `-d` or `-D` option, `<branchname>` will be deleted.  You may
  specify more than one branch for deletion.  If the branch currently
  has a reflog then the reflog will also be deleted.
@@@ -86,7 -81,7 +86,7 @@@ OPTION
  --delete::
        Delete a branch. The branch must be fully merged in its
        upstream branch, or in `HEAD` if no upstream was set with
-       `--track` or `--set-upstream`.
+       `--track` or `--set-upstream-to`.
  
  -D::
        Shortcut for `--delete --force`.
        all changes made to the branch ref, enabling use of date
        based sha1 expressions such as "<branchname>@\{yesterday}".
        Note that in non-bare repositories, reflogs are usually
 -      enabled by default by the `core.logallrefupdates` config option.
 +      enabled by default by the `core.logAllRefUpdates` config option.
        The negated form `--no-create-reflog` only overrides an earlier
        `--create-reflog`, but currently does not negate the setting of
 -      `core.logallrefupdates`.
 +      `core.logAllRefUpdates`.
  
  -f::
  --force::
 -      Reset <branchname> to <startpoint> if <branchname> exists
 -      already. Without `-f` 'git branch' refuses to change an existing branch.
 +      Reset <branchname> to <startpoint>, even if <branchname> exists
 +      already. Without `-f`, 'git branch' refuses to change an existing branch.
        In combination with `-d` (or `--delete`), allow deleting the
        branch irrespective of its merged status. In combination with
        `-m` (or `--move`), allow renaming the branch even if the new
 -      branch name already exists.
 +      branch name already exists, the same applies for `-c` (or `--copy`).
  
  -m::
  --move::
  -M::
        Shortcut for `--move --force`.
  
 +-c::
 +--copy::
 +      Copy a branch and the corresponding reflog.
 +
 +-C::
 +      Shortcut for `--copy --force`.
 +
  --color[=<when>]::
        Color branches to highlight current, local, and
        remote-tracking branches.
@@@ -277,16 -265,10 +277,16 @@@ start-point is either a local or remote
        Only list branches of the given object.
  
  --format <format>::
 -      A string that interpolates `%(fieldname)` from the object
 -      pointed at by a ref being shown.  The format is the same as
 +      A string that interpolates `%(fieldname)` from a branch ref being shown
 +      and the object it points at.  The format is the same as
        that of linkgit:git-for-each-ref[1].
  
 +CONFIGURATION
 +-------------
 +`pager.branch` is only respected when listing branches, i.e., when
 +`--list` is used or implied. The default is to use a pager.
 +See linkgit:git-config[1].
 +
  Examples
  --------