Re: [PATCH 3/6] branch: teach --edit-description option

From: Michael J Gruber <git@drmicha.warpmail.net>
Date: Sep 23, 2011, 09:00 UTC
Message-ID: <4E7C4ABF.1020804@drmicha.warpmail.net>
In-Reply-To: <1316729362-7714-4-git-send-email-gitster@pobox.com>

Junio C Hamano venit, vidit, dixit 23.09.2011 00:09:

Show 10 quoted lines

> 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).

I don't think that is the only reason why we should not make "git branch -m foo bar" set the description "foo" for branch "bar"...

Granted, your argument applies to "--set-description" ("-m"-like) also.

Michael

Show 14 quoted lines

> 
> Signed-off-by: Junio C Hamano <gitster@pobox.com>
> ---
>  Documentation/git-branch.txt |    5 +++
>  builtin/branch.c             |   56 ++++++++++++++++++++++++++++++++++++++++-
>  2 files changed, 59 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt
> index 507b8d0..8871a4e 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>]