Re: [PATCH 1/5] docs: mention "-k" for both forms of "git mv"

From: Junio C Hamano <gitster@pobox.com>
Date: Dec 12, 2011, 19:52 UTC
Message-ID: <7v1us94lg7.fsf@alter.siamese.dyndns.org>
In-Reply-To: <20111212075031.GA17532@sigill.intra.peff.net>

Jeff King <peff@peff.net> writes:

Show 7 quoted lines

> I actually would rather just see:
>
>   git mv [options] <source> <destination>
>   git mv [options] <source>... <destination>
>
> but if we are going to go that route, we should probably decide on a
> style and convert all of the descriptions at the same time.

Also most commands when they use these multi-line synopsis style to differenciate different invocation contexts do take different set of options for different contexts, so we would need to update the option descriptions to say "this option only makes sense in this context", etc.

Show 16 quoted lines

>  Documentation/git-mv.txt |    2 +-
>  1 files changed, 1 insertions(+), 1 deletions(-)
>
> diff --git a/Documentation/git-mv.txt b/Documentation/git-mv.txt
> index b8db373..4be7a71 100644
> --- a/Documentation/git-mv.txt
> +++ b/Documentation/git-mv.txt
> @@ -15,7 +15,7 @@ DESCRIPTION
>  -----------
>  This script is used to move or rename a file, directory or symlink.
>  
> - git mv [-f] [-n] <source> <destination>
> + git mv [-f] [-n] [-k] <source> <destination>
>   git mv [-f] [-n] [-k] <source> ... <destination directory>
>  
>  In the first form, it renames <source>, which must exist and be either