diff options
| author | Junio C Hamano <gitster@pobox.com> | 2011-09-20 15:10:08 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2011-10-05 14:51:26 -0700 |
| commit | b7200e839737491dfe8f0297fba54621fd7d7583 (patch) | |
| tree | 2d9fc810c36bbe76729a4252bbe8bcccacdc350a /Documentation/git-branch.txt | |
| parent | 739453a3fb74ade725243ac972f02ba1aedabdf6 (diff) | |
| download | git-b7200e839737491dfe8f0297fba54621fd7d7583.tar.gz | |
branch: teach --edit-description option
Using branch.$name.description as the configuration key, give users a
place to write about what the purpose of the branch is and things like
that, so that various subsystems, e.g. "push -s", "request-pull", and
"format-patch --cover-letter", can later be taught to use this
information.
The "-m" option similar to "commit/tag" is deliberately omitted, as the
whole point of branch description is about giving descriptive information
(the name of the branch itself is a better place for information that fits
on a single-line).
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-branch.txt')
| -rw-r--r-- | Documentation/git-branch.txt | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt index 507b8d0ab2..8871a4ec21 100644 --- a/Documentation/git-branch.txt +++ b/Documentation/git-branch.txt @@ -14,6 +14,7 @@ SYNOPSIS 'git branch' [--set-upstream | --track | --no-track] [-l] [-f] <branchname> [<start-point>] 'git branch' (-m | -M) [<oldbranch>] <newbranch> 'git branch' (-d | -D) [-r] <branchname>... +'git branch' --edit-description [<branchname>] DESCRIPTION ----------- @@ -144,6 +145,10 @@ start-point is either a local or remote-tracking branch. like '--track' would when creating the branch, except that where branch points to is not changed. +--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`). + --contains <commit>:: Only list branches which contain the specified commit. |