From: Junio C Hamano Date: Thu, 17 Sep 2015 19:29:03 +0000 (-0700) Subject: Merge branch 'po/doc-branch-desc' X-Git-Tag: v2.6.0-rc3~6 X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/a2654356d4ef9ffac4adda2b053d45def8e0a45c?hp=-c Merge branch 'po/doc-branch-desc' The branch descriptions that are set with "git branch --edit-description" option were used in many places but they weren't clearly documented. * po/doc-branch-desc: doc: show usage of branch description --- a2654356d4ef9ffac4adda2b053d45def8e0a45c diff --combined Documentation/git-branch.txt index a67138a022,e496141bc5..bbbade4f51 --- a/Documentation/git-branch.txt +++ b/Documentation/git-branch.txt @@@ -51,7 -51,7 +51,7 @@@ When a local branch is started off a re branch (specifically the `branch..remote` and `branch..merge` configuration entries) so that 'git pull' will appropriately merge from the remote-tracking branch. This behavior may be changed via the global -`branch.autosetupmerge` configuration flag. That setting can be +`branch.autoSetupMerge` configuration flag. That setting can be overridden by using the `--track` and `--no-track` options, and changed later using `git branch --set-upstream-to`. @@@ -81,7 -81,7 +81,7 @@@ OPTION `--track` or `--set-upstream`. -D:: - Delete a branch irrespective of its merged status. + Shortcut for `--delete --force`. -l:: --create-reflog:: @@@ -95,17 -95,13 +95,17 @@@ --force:: Reset to if 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. -m:: --move:: Move/rename a branch and the corresponding reflog. -M:: - Move/rename a branch even if the new branch name already exists. + Shortcut for `--move --force`. --color[=]:: Color branches to highlight current, local, and @@@ -170,14 -166,14 +170,14 @@@ This option is only applicable in non-v upstream when the new branch is checked out. + This behavior is the default when the start point is a remote-tracking branch. -Set the branch.autosetupmerge configuration variable to `false` if you +Set the branch.autoSetupMerge configuration variable to `false` if you want `git checkout` and `git branch` to always behave as if '--no-track' were given. Set it to `always` if you want this behavior when the start-point is either a local or remote-tracking branch. --no-track:: Do not set up "upstream" configuration, even if the - branch.autosetupmerge configuration variable is true. + branch.autoSetupMerge configuration variable is true. --set-upstream:: If specified branch does not exist yet or if `--force` has been @@@ -197,7 -193,9 +197,9 @@@ --edit-description:: Open an editor and edit the text to explain what the branch is - for, to be used by various other commands (e.g. `request-pull`). + for, to be used by various other commands (e.g. `format-patch`, + `request-pull`, and `merge` (if enabled)). Multi-line explanations + may be used. --contains []:: Only list branches which contain the specified commit (HEAD diff --combined Documentation/git-format-patch.txt index 0dac4e9b86,037ceb21b1..4035649117 --- a/Documentation/git-format-patch.txt +++ b/Documentation/git-format-patch.txt @@@ -170,7 -170,7 +170,7 @@@ will want to ensure that threading is d -v :: --reroll-count=:: Mark the series as the -th iteration of the topic. The - output filenames have `v` pretended to them, and the + output filenames have `v` prepended to them, and the subject prefix ("PATCH" by default, but configurable via the `--subject-prefix` option) has ` v` appended to it. E.g. `--reroll-count=4` may produce `v4-0001-add-makefile.patch` @@@ -213,7 -213,7 +213,7 @@@ feeding the result to `git send-email` --[no-]cover-letter:: In addition to the patches, generate a cover letter file - containing the shortlog and the overall diffstat. You can + containing the branch description, shortlog and the overall diffstat. You can fill in a description in the file before sending it out. --notes[=]:: @@@ -273,13 -273,13 +273,13 @@@ attachments, and sign off patches with ------------ [format] headers = "Organization: git-foo\n" - subjectprefix = CHANGE + subjectPrefix = CHANGE suffix = .txt numbered = auto to = cc = attach [ = mime-boundary-string ] - signoff = true + signOff = true coverletter = auto ------------ diff --combined Documentation/git-merge.txt index 273a1009be,7366c3a0b6..a62d6729b9 --- a/Documentation/git-merge.txt +++ b/Documentation/git-merge.txt @@@ -78,7 -78,7 +78,7 @@@ will be appended to the specified messa + The 'git fmt-merge-msg' command can be used to give a good default for automated 'git merge' - invocations. + invocations. The automated message can include the branch description. --[no-]rerere-autoupdate:: Allow the rerere mechanism to update the index with the @@@ -104,10 -104,6 +104,10 @@@ commit or stash your changes before run If no commit is given from the command line, merge the remote-tracking branches that the current branch is configured to use as its upstream. See also the configuration section of this manual page. ++ +When `FETCH_HEAD` (and no other commit) is specified, the branches +recorded in the `.git/FETCH_HEAD` file by the previous invocation +of `git fetch` for merging are merged to the current branch. PRE-MERGE CHECKS @@@ -236,7 -232,7 +236,7 @@@ Barbie's remark on your side. The onl side wants to say it is hard and you'd prefer to go shopping, while the other side wants to claim it is easy. -An alternative style can be used by setting the "merge.conflictstyle" +An alternative style can be used by setting the "merge.conflictStyle" configuration variable to "diff3". In "diff3" style, the above conflict may look like this: @@@ -333,7 -329,7 +333,7 @@@ CONFIGURATIO ------------- include::merge-config.txt[] -branch..mergeoptions:: +branch..mergeOptions:: Sets default options for merging into branch . The syntax and supported options are the same as those of 'git merge', but option values containing whitespace characters are currently not supported.